Package com.oracle.bmc.demandsignal

Interface OccMetricAlarmAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OccMetricAlarmAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240430")
public interface OccMetricAlarmAsync
extends AutoCloseable
    Use the OCI Control Center Demand Signal API to manage Demand Signals.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

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

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • createOccMetricAlarm

        Future<CreateOccMetricAlarmResponse> createOccMetricAlarm​(CreateOccMetricAlarmRequest request,
                                                          AsyncHandler<CreateOccMetricAlarmRequest,​CreateOccMetricAlarmResponse> handler)
        Creates a new OccMetricAlarm resource in the specified compartment with the provided configuration details.
        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.

      • deleteOccMetricAlarm

        Future<DeleteOccMetricAlarmResponse> deleteOccMetricAlarm​(DeleteOccMetricAlarmRequest request,
                                                          AsyncHandler<DeleteOccMetricAlarmRequest,​DeleteOccMetricAlarmResponse> handler)
        Deletes the specified OccMetricAlarm resource.
        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.

      • getOccMetricAlarm

        Future<GetOccMetricAlarmResponse> getOccMetricAlarm​(GetOccMetricAlarmRequest request,
                                                    AsyncHandler<GetOccMetricAlarmRequest,​GetOccMetricAlarmResponse> handler)
        Retrieves the specified OccMetricAlarm resource based on its identifier.
        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.

      • listOccMetricAlarms

        Future<ListOccMetricAlarmsResponse> listOccMetricAlarms​(ListOccMetricAlarmsRequest request,
                                                        AsyncHandler<ListOccMetricAlarmsRequest,​ListOccMetricAlarmsResponse> handler)
        Gets a list of OccMetricAlarms.
        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.

      • updateOccMetricAlarm

        Future<UpdateOccMetricAlarmResponse> updateOccMetricAlarm​(UpdateOccMetricAlarmRequest request,
                                                          AsyncHandler<UpdateOccMetricAlarmRequest,​UpdateOccMetricAlarmResponse> handler)
        Updates an existing OccMetricAlarm resource with new or modified configuration details.
        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.