com.oracle.bmc.monitoring

Interface MonitoringAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

MonitoringAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public interface MonitoringAsync
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.

Method Summary

Modifier and Type	Method and Description
Future<ChangeAlarmCompartmentResponse>	changeAlarmCompartment(ChangeAlarmCompartmentRequest request, AsyncHandler<ChangeAlarmCompartmentRequest,ChangeAlarmCompartmentResponse> handler) Moves an alarm into a different compartment within the same tenancy.
Future<CreateAlarmResponse>	createAlarm(CreateAlarmRequest request, AsyncHandler<CreateAlarmRequest,CreateAlarmResponse> handler) Creates a new alarm in the specified compartment.
Future<DeleteAlarmResponse>	deleteAlarm(DeleteAlarmRequest request, AsyncHandler<DeleteAlarmRequest,DeleteAlarmResponse> handler) Deletes the specified alarm.
Future<GetAlarmResponse>	getAlarm(GetAlarmRequest request, AsyncHandler<GetAlarmRequest,GetAlarmResponse> handler) Gets the specified alarm.
Future<GetAlarmHistoryResponse>	getAlarmHistory(GetAlarmHistoryRequest request, AsyncHandler<GetAlarmHistoryRequest,GetAlarmHistoryResponse> handler) Get the history of the specified alarm.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListAlarmsResponse>	listAlarms(ListAlarmsRequest request, AsyncHandler<ListAlarmsRequest,ListAlarmsResponse> handler) Lists the alarms for the specified compartment.
Future<ListAlarmsStatusResponse>	listAlarmsStatus(ListAlarmsStatusRequest request, AsyncHandler<ListAlarmsStatusRequest,ListAlarmsStatusResponse> handler) List the status of each alarm in the specified compartment.
Future<ListMetricsResponse>	listMetrics(ListMetricsRequest request, AsyncHandler<ListMetricsRequest,ListMetricsResponse> handler) Returns metric definitions that match the criteria specified in the request.
Future<PostMetricDataResponse>	postMetricData(PostMetricDataRequest request, AsyncHandler<PostMetricDataRequest,PostMetricDataResponse> handler) Publishes raw metric data points to the Monitoring service.
Future<RemoveAlarmSuppressionResponse>	removeAlarmSuppression(RemoveAlarmSuppressionRequest request, AsyncHandler<RemoveAlarmSuppressionRequest,RemoveAlarmSuppressionResponse> handler) 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’).
Future<SummarizeMetricsDataResponse>	summarizeMetricsData(SummarizeMetricsDataRequest request, AsyncHandler<SummarizeMetricsDataRequest,SummarizeMetricsDataResponse> handler) Returns aggregated data that match the criteria specified in the request.
Future<UpdateAlarmResponse>	updateAlarm(UpdateAlarmRequest request, AsyncHandler<UpdateAlarmRequest,UpdateAlarmResponse> handler) 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 serice.

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

Future<ChangeAlarmCompartmentResponse> changeAlarmCompartment(ChangeAlarmCompartmentRequest request,
                                                              AsyncHandler<ChangeAlarmCompartmentRequest,ChangeAlarmCompartmentResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createAlarm

Future<CreateAlarmResponse> createAlarm(CreateAlarmRequest request,
                                        AsyncHandler<CreateAlarmRequest,CreateAlarmResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteAlarm

Future<DeleteAlarmResponse> deleteAlarm(DeleteAlarmRequest request,
                                        AsyncHandler<DeleteAlarmRequest,DeleteAlarmResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAlarm

Future<GetAlarmResponse> getAlarm(GetAlarmRequest request,
                                  AsyncHandler<GetAlarmRequest,GetAlarmResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAlarmHistory

Future<GetAlarmHistoryResponse> getAlarmHistory(GetAlarmHistoryRequest request,
                                                AsyncHandler<GetAlarmHistoryRequest,GetAlarmHistoryResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAlarms

Future<ListAlarmsResponse> listAlarms(ListAlarmsRequest request,
                                      AsyncHandler<ListAlarmsRequest,ListAlarmsResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAlarmsStatus

Future<ListAlarmsStatusResponse> listAlarmsStatus(ListAlarmsStatusRequest request,
                                                  AsyncHandler<ListAlarmsStatusRequest,ListAlarmsStatusResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listMetrics

Future<ListMetricsResponse> listMetrics(ListMetricsRequest request,
                                        AsyncHandler<ListMetricsRequest,ListMetricsResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

postMetricData

Future<PostMetricDataResponse> postMetricData(PostMetricDataRequest request,
                                              AsyncHandler<PostMetricDataRequest,PostMetricDataResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

removeAlarmSuppression

Future<RemoveAlarmSuppressionResponse> removeAlarmSuppression(RemoveAlarmSuppressionRequest request,
                                                              AsyncHandler<RemoveAlarmSuppressionRequest,RemoveAlarmSuppressionResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

summarizeMetricsData

Future<SummarizeMetricsDataResponse> summarizeMetricsData(SummarizeMetricsDataRequest request,
                                                          AsyncHandler<SummarizeMetricsDataRequest,SummarizeMetricsDataResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateAlarm

Future<UpdateAlarmResponse> updateAlarm(UpdateAlarmRequest request,
                                        AsyncHandler<UpdateAlarmRequest,UpdateAlarmResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.