Monitoring (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

MonitoringClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public interface Monitoring
extends AutoCloseable
```
Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources. Endpoints vary by operation. For PostMetric, use the telemetry-ingestion endpoints; for all other operations, use the telemetry endpoints. For information about monitoring, see Monitoring Overview.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ChangeAlarmCompartmentResponse`	`changeAlarmCompartment(ChangeAlarmCompartmentRequest request)` Moves an alarm into a different compartment within the same tenancy.
`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.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`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.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
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.
    
    Parameters:
    
    regionId - The public region ID.
  - changeAlarmCompartment
```
ChangeAlarmCompartmentResponse changeAlarmCompartment(ChangeAlarmCompartmentRequest request)
```
    Moves an alarm into a different compartment within the same tenancy.
    
    For information about moving resources between compartments, see [Moving Resources Between Compartments](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use ChangeAlarmCompartment API.
  - createAlarm
```
CreateAlarmResponse createAlarm(CreateAlarmRequest request)
```
    Creates a new alarm in the specified compartment. For important limits information, see Limits on Monitoring.
    
    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use CreateAlarm API.
  - deleteAlarm
```
DeleteAlarmResponse deleteAlarm(DeleteAlarmRequest request)
```
    Deletes the specified alarm. For important limits information, see Limits on Monitoring.
    
    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use DeleteAlarm API.
  - getAlarm
```
GetAlarmResponse getAlarm(GetAlarmRequest request)
```
    Gets the specified alarm. For important limits information, see Limits on Monitoring.
    
    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use GetAlarm API.
  - getAlarmHistory
```
GetAlarmHistoryResponse getAlarmHistory(GetAlarmHistoryRequest request)
```
    Get the history of the specified alarm. For important limits information, see Limits on Monitoring.
    
    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use GetAlarmHistory API.
  - listAlarms
```
ListAlarmsResponse listAlarms(ListAlarmsRequest request)
```
    Lists the alarms for the specified compartment. For important limits information, see Limits on Monitoring.
    
    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use ListAlarms API.
  - listAlarmsStatus
```
ListAlarmsStatusResponse listAlarmsStatus(ListAlarmsStatusRequest request)
```
    List the status of each alarm in the specified compartment. For important limits information, see Limits on Monitoring.
    
    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use ListAlarmsStatus API.
  - listMetrics
```
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. For important limits information, see Limits on Monitoring.
    
    Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use ListMetrics API.
  - postMetricData
```
PostMetricDataResponse postMetricData(PostMetricDataRequest request)
```
    Publishes raw metric data points to the Monitoring service. For more information about publishing metrics, see Publishing Custom Metrics. For important limits information, see Limits on Monitoring.
    
    Per-call limits information follows.
    Dimensions per metric group*. Maximum: 20. Minimum: 1. * Unique metric streams*. Maximum: 50. * Transactions Per Second (TPS) per-tenancy limit for this operation: 50.
    A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. A dimension is a qualifier provided in a metric definition. A metric stream is an individual set of aggregated data for a metric, typically specific to a resource. For more information about metric-related concepts, see [Monitoring Concepts](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).
    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:
    https://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use PostMetricData API.
  - removeAlarmSuppression
```
RemoveAlarmSuppressionResponse removeAlarmSuppression(RemoveAlarmSuppressionRequest request)
```
    Removes any existing suppression for the specified alarm. For important limits information, see Limits on Monitoring.
    
    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use RemoveAlarmSuppression API.
  - summarizeMetricsData
```
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. For important limits information, see Limits on Monitoring.
    
    Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use SummarizeMetricsData API.
  - updateAlarm
```
UpdateAlarmResponse updateAlarm(UpdateAlarmRequest request)
```
    Updates the specified alarm. For important limits information, see Limits on Monitoring.
    
    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    
    Example: Click here to see how to use UpdateAlarm API.
  - getWaiters
```
MonitoringWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
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.
    
    Returns:
    
    The service paginators.

Interface Monitoring

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

setEndpoint

getEndpoint

setRegion

setRegion

changeAlarmCompartment

createAlarm

deleteAlarm

getAlarm

getAlarmHistory

listAlarms

listAlarmsStatus

listMetrics

postMetricData

removeAlarmSuppression

summarizeMetricsData

updateAlarm

getWaiters

getPaginators