@Generated(value="OracleSDKGenerator", comments="API Version: 20180401") public interface Monitoring extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
CreateAlarmResponse |
createAlarm(CreateAlarmRequest request)
Creates a new alarm in the specified compartment.
|
DeleteAlarmResponse |
deleteAlarm(DeleteAlarmRequest request)
Deletes the specified alarm.
|
GetAlarmResponse |
getAlarm(GetAlarmRequest request)
Gets the specified alarm.
|
GetAlarmHistoryResponse |
getAlarmHistory(GetAlarmHistoryRequest request)
Get the history of the specified alarm.
|
MonitoringPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
MonitoringWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListAlarmsResponse |
listAlarms(ListAlarmsRequest request)
Lists the alarms for the specified compartment.
|
ListAlarmsStatusResponse |
listAlarmsStatus(ListAlarmsStatusRequest request)
List the status of each alarm in the specified compartment.
|
ListMetricsResponse |
listMetrics(ListMetricsRequest request)
Returns metric definitions that match the criteria specified in the request.
|
PostMetricDataResponse |
postMetricData(PostMetricDataRequest request)
Publishes raw metric data points to the Monitoring service.
|
RemoveAlarmSuppressionResponse |
removeAlarmSuppression(RemoveAlarmSuppressionRequest request)
Removes any existing suppression for the specified alarm.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
SummarizeMetricsDataResponse |
summarizeMetricsData(SummarizeMetricsDataRequest request)
Returns aggregated data that match the criteria specified in the request.
|
UpdateAlarmResponse |
updateAlarm(UpdateAlarmRequest request)
Updates the specified alarm.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.CreateAlarmResponse createAlarm(CreateAlarmRequest request)
Creates a new alarm in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteAlarmResponse deleteAlarm(DeleteAlarmRequest request)
Deletes the specified alarm.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetAlarmResponse getAlarm(GetAlarmRequest request)
Gets the specified alarm.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetAlarmHistoryResponse getAlarmHistory(GetAlarmHistoryRequest request)
Get the history of the specified alarm.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListAlarmsResponse listAlarms(ListAlarmsRequest request)
Lists the alarms for the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListAlarmsStatusResponse listAlarmsStatus(ListAlarmsStatusRequest request)
List the status of each alarm in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListMetricsResponse listMetrics(ListMetricsRequest request)
Returns metric definitions that match the criteria specified in the request. Compartment OCID required. For information about metrics, see Metrics Overview.
request
- The request object containing the details to sendBmcException
- when an error occurs.PostMetricDataResponse postMetricData(PostMetricDataRequest request)
Publishes raw metric data points to the Monitoring service. For more information about publishing metrics, see Publishing Custom Metrics.
The endpoints for this operation differ from other Monitoring operations. Replace the string telemetry
with telemetry-ingestion
in the endpoint, as in the following example:
request
- The request object containing the details to sendBmcException
- when an error occurs.RemoveAlarmSuppressionResponse removeAlarmSuppression(RemoveAlarmSuppressionRequest request)
Removes any existing suppression for the specified alarm.
request
- The request object containing the details to sendBmcException
- when an error occurs.SummarizeMetricsDataResponse summarizeMetricsData(SummarizeMetricsDataRequest request)
Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For information on metric queries, see Building Metric Queries.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateAlarmResponse updateAlarm(UpdateAlarmRequest request)
Updates the specified alarm.
request
- The request object containing the details to sendBmcException
- when an error occurs.MonitoringWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
MonitoringPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
Copyright © 2016–2019. All rights reserved.