Package com.oracle.bmc.monitoring

Class MonitoringClient

    • 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.

    • Method Detail

      • 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.

      • 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.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.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.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.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.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status.htm). For important limits information, see [Limits on Monitoring](https://docs.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.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm) and [Custom Metrics Walkthrough](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/custom-metrics-walkthrough.htm). For information about developing a metric-posting client, see [Developer Guide](https://docs.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.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.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.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status-metric-stream.htm).

        For important limits information, see [Limits on Monitoring](https://docs.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.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

      • 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.

      • enableDualStackEndpoints

        public void enableDualStackEndpoints​(boolean enableDualStackEndpoints)
        This method should be used to enable or disable the use of dual-stack endpoints.

        The default value is false i.e. dual-stack endpoints are disabled by default.

        Parameters:
        enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively

      • getOptionsMap

        public Map<String,​Boolean> getOptionsMap()
        Return an immutable snapshot representing the current options set for this client.
        Returns:
        immutable snapshot representing the current options set for this client

      • getResolvedEndpoint

        public String getResolvedEndpoint​(Map<String,​Object> requiredParametersMap)
        Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
        Parameters:
        requiredParametersMap - the map from required parameter name to their values
        Returns:
        resolved endpoint, with all options and placeholders filled in

      • 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

      • setEndpoint

        public final void setEndpoint​(String endpoint)

      • getEndpoint

        public final String getEndpoint()
        Get the endpoint of the client.

        Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.

        Examples of endpoints this may return:

        • Unparameterized endpoints 
                       https://identity.us-phoenix-1.oci.oraclecloud.com
             https://identity.us-ashburn-1.oci.oraclecloud.com
             https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
        • Parameterized endpoints with placeholders 
                       https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com
             https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
        • Parameterized endpoints with options 
                       https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com
             https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
        • Parameterized endpoints with placeholders and options 
                       https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com
             https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com

        To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

        Returns:
        the endpoint being used by the client

      • 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.

      • getClientCommonLibraryVersion

        public String getClientCommonLibraryVersion()

      • getMinimumClientCommonLibraryVersionFromClient

        public Optional<String> getMinimumClientCommonLibraryVersionFromClient()