com.oracle.bmc.monitoring

Class MonitoringClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.monitoring.MonitoringClient

All Implemented Interfaces:

Monitoring, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public class MonitoringClient
extends BaseSyncClient
implements Monitoring

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitoringClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Monitoring.

Constructor Summary

Constructors

Constructor and Description
MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
MonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
MonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
MonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static MonitoringClient.Builder	builder() Create a builder for this client.
ChangeAlarmCompartmentResponse	changeAlarmCompartment(ChangeAlarmCompartmentRequest request) Moves an alarm into a different compartment within the same tenancy.
void	close()
CreateAlarmResponse	createAlarm(CreateAlarmRequest request) Creates a new alarm in the specified compartment.
CreateAlarmSuppressionResponse	createAlarmSuppression(CreateAlarmSuppressionRequest request) Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific).
DeleteAlarmResponse	deleteAlarm(DeleteAlarmRequest request) Deletes the specified alarm.
DeleteAlarmSuppressionResponse	deleteAlarmSuppression(DeleteAlarmSuppressionRequest request) Deletes the specified alarm suppression.
GetAlarmResponse	getAlarm(GetAlarmRequest request) Gets the specified alarm.
GetAlarmHistoryResponse	getAlarmHistory(GetAlarmHistoryRequest request) Get the history of the specified alarm.
GetAlarmSuppressionResponse	getAlarmSuppression(GetAlarmSuppressionRequest request) Gets the specified alarm suppression.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
ListAlarmSuppressionsResponse	listAlarmSuppressions(ListAlarmSuppressionsRequest request) Lists alarm suppressions for the specified alarm.
ListMetricsResponse	listMetrics(ListMetricsRequest request) Returns metric definitions that match the criteria specified in the request.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
PostMetricDataResponse	postMetricData(PostMetricDataRequest request) Publishes raw metric data points to the Monitoring service.
void	refreshClient() Rebuild the backing HttpClient.
RemoveAlarmSuppressionResponse	removeAlarmSuppression(RemoveAlarmSuppressionRequest request) Removes any existing suppression for the specified alarm.
RetrieveDimensionStatesResponse	retrieveDimensionStates(RetrieveDimensionStatesRequest request) Lists the current alarm status of each metric stream, where status is derived from the metric stream’s last associated transition.
void	setEndpoint(String endpoint)
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’).
SummarizeAlarmSuppressionHistoryResponse	summarizeAlarmSuppressionHistory(SummarizeAlarmSuppressionHistoryRequest request) Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions.
SummarizeMetricsDataResponse	summarizeMetricsData(SummarizeMetricsDataRequest request) Returns aggregated data that match the criteria specified in the request.
UpdateAlarmResponse	updateAlarm(UpdateAlarmRequest request) Updates the specified alarm.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.monitoring.Monitoring

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Monitoring.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

MonitoringClient

@Deprecated
public MonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

MonitoringClient

@Deprecated
public MonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

MonitoringClient

@Deprecated
public MonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

MonitoringClient

@Deprecated
public MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

MonitoringClient

@Deprecated
public MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

MonitoringClient

@Deprecated
public MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

MonitoringClient

@Deprecated
public MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

MonitoringClient

@Deprecated
public MonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint,
                                    ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - MonitoringClient.Builder.executorService

Method Detail

builder

public static MonitoringClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Monitoring

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.

Specified by:

setRegion in interface Monitoring

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Monitoring

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.

Specified by:

setRegion in interface Monitoring

Parameters:

regionId - The public region ID.

changeAlarmCompartment

public ChangeAlarmCompartmentResponse changeAlarmCompartment(ChangeAlarmCompartmentRequest request)

Description copied from interface: Monitoring

Moves an alarm into a different compartment within the same tenancy. For more information, see Moving an Alarm.

Specified by:

changeAlarmCompartment in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAlarm

public CreateAlarmResponse createAlarm(CreateAlarmRequest request)

Description copied from interface: Monitoring

Creates a new alarm in the specified compartment. For more information, see Creating an 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.

Specified by:

createAlarm in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAlarmSuppression

public CreateAlarmSuppressionResponse createAlarmSuppression(CreateAlarmSuppressionRequest request)

Description copied from interface: Monitoring

Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific). For more information, see Adding an Alarm-wide Suppression and Adding a Dimension-Specific Alarm Suppression.

For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

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.

Specified by:

createAlarmSuppression in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAlarm

public DeleteAlarmResponse deleteAlarm(DeleteAlarmRequest request)

Description copied from interface: Monitoring

Deletes the specified alarm. For more information, see Deleting an 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.

Specified by:

deleteAlarm in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAlarmSuppression

public DeleteAlarmSuppressionResponse deleteAlarmSuppression(DeleteAlarmSuppressionRequest request)

Description copied from interface: Monitoring

Deletes the specified alarm suppression. For more information, see Removing an Alarm-wide Suppression and Removing a Dimension-Specific Alarm Suppression.

For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

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.

Specified by:

deleteAlarmSuppression in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAlarm

public GetAlarmResponse getAlarm(GetAlarmRequest request)

Description copied from interface: Monitoring

Gets the specified alarm. For more information, see Getting an 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.

Specified by:

getAlarm in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAlarmHistory

public GetAlarmHistoryResponse getAlarmHistory(GetAlarmHistoryRequest request)

Description copied from interface: Monitoring

Get the history of the specified alarm. For more information, see Getting History of an 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.

Specified by:

getAlarmHistory in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAlarmSuppression

public GetAlarmSuppressionResponse getAlarmSuppression(GetAlarmSuppressionRequest request)

Description copied from interface: Monitoring

Gets the specified alarm suppression. For more information, see Getting an Alarm-wide Suppression.

For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

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.

Specified by:

getAlarmSuppression in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAlarmSuppressions

public ListAlarmSuppressionsResponse listAlarmSuppressions(ListAlarmSuppressionsRequest request)

Description copied from interface: Monitoring

Lists alarm suppressions for the specified alarm. For more information, see Listing Alarm Suppressions.

For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

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.

Specified by:

listAlarmSuppressions in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAlarms

public ListAlarmsResponse listAlarms(ListAlarmsRequest request)

Description copied from interface: Monitoring

Lists the alarms for the specified compartment. For more information, see Listing Alarms. 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.

Specified by:

listAlarms in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAlarmsStatus

public ListAlarmsStatusResponse listAlarmsStatus(ListAlarmsStatusRequest request)

Description copied from interface: Monitoring

List the status of each alarm in the specified compartment. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use retrieveDimensionStates. Optionally filter by resource or status value.

For more information, see [Listing Alarm Statuses](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status.htm). For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

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.

Specified by:

listAlarmsStatus in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMetrics

public ListMetricsResponse listMetrics(ListMetricsRequest request)

Description copied from interface: Monitoring

Returns metric definitions that match the criteria specified in the request. Compartment OCID required. For more information, see Listing Metric Definitions. 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.

Specified by:

listMetrics in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

postMetricData

public PostMetricDataResponse postMetricData(PostMetricDataRequest request)

Description copied from interface: Monitoring

Publishes raw metric data points to the Monitoring service. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).

For more information about publishing metrics, see [Publishing Custom Metrics](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm) and [Custom Metrics Walkthrough](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/custom-metrics-walkthrough.htm). For information about developing a metric-posting client, see [Developer Guide](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/devtoolslanding.htm). For an example client, see [MonitoringMetricPostExample.java](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/MonitoringMetricPostExample.java). For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

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 with zero or more dimension values. For more information about metric-related concepts, see [Monitoring Concepts](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).

*Note:** 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

Specified by:

postMetricData in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeAlarmSuppression

public RemoveAlarmSuppressionResponse removeAlarmSuppression(RemoveAlarmSuppressionRequest request)

Description copied from interface: Monitoring

Removes any existing suppression for the specified alarm. For more information, see Removing Suppression from an 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.

Specified by:

removeAlarmSuppression in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

retrieveDimensionStates

public RetrieveDimensionStatesResponse retrieveDimensionStates(RetrieveDimensionStatesRequest request)

Description copied from interface: Monitoring

Lists the current alarm status of each metric stream, where status is derived from the metric stream’s last associated transition. Optionally filter by status value and one or more dimension key-value pairs.

For more information, see [Listing Metric Stream Status in an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status-metric-stream.htm).

For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

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.

Specified by:

retrieveDimensionStates in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeAlarmSuppressionHistory

public SummarizeAlarmSuppressionHistoryResponse summarizeAlarmSuppressionHistory(SummarizeAlarmSuppressionHistoryRequest request)

Description copied from interface: Monitoring

Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions. For more information, see Getting Suppression History for an Alarm.

For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

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.

Specified by:

summarizeAlarmSuppressionHistory in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeMetricsData

public SummarizeMetricsDataResponse summarizeMetricsData(SummarizeMetricsDataRequest request)

Description copied from interface: Monitoring

Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For more information, see Querying Metric Data and Creating a Query. For important limits information, see Limits on Monitoring.

Transactions Per Second (TPS) per-tenancy limit for this operation: 10.

Specified by:

summarizeMetricsData in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAlarm

public UpdateAlarmResponse updateAlarm(UpdateAlarmRequest request)

Description copied from interface: Monitoring

Updates the specified alarm. For more information, see Updating an 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.

Specified by:

updateAlarm in interface Monitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public MonitoringWaiters getWaiters()

Description copied from interface: Monitoring

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Monitoring

Returns:

The service waiters.

getPaginators

public MonitoringPaginators getPaginators()

Description copied from interface: Monitoring

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.

Specified by:

getPaginators in interface Monitoring

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()