Package com.oracle.bmc.capacitymanagement

Interface DemandSignalAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DemandSignalAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20231107")
public interface DemandSignalAsync
extends AutoCloseable
    OCI Control Center (OCC) Capacity Management enables you to manage capacity requests in realms where OCI Control Center Capacity Management is available.

    For more information, see OCI Control Center.

    • 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

      • bulkCreateOccmDemandSignalItem

        Future<BulkCreateOccmDemandSignalItemResponse> bulkCreateOccmDemandSignalItem​(BulkCreateOccmDemandSignalItemRequest request,
                                                                              AsyncHandler<BulkCreateOccmDemandSignalItemRequest,​BulkCreateOccmDemandSignalItemResponse> handler)
        This API will help in bulk creation of demand signal items.

        This API is atomic i.e either all the demand signal item resources will be created or none will be created.

        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.

      • createOccmDemandSignal

        Future<CreateOccmDemandSignalResponse> createOccmDemandSignal​(CreateOccmDemandSignalRequest request,
                                                              AsyncHandler<CreateOccmDemandSignalRequest,​CreateOccmDemandSignalResponse> handler)
        This is a post API to create occm demand signal.
        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.

      • createOccmDemandSignalItem

        Future<CreateOccmDemandSignalItemResponse> createOccmDemandSignalItem​(CreateOccmDemandSignalItemRequest request,
                                                                      AsyncHandler<CreateOccmDemandSignalItemRequest,​CreateOccmDemandSignalItemResponse> handler)
        This API will create a demand signal item representing a resource request.

        This needs to be grouped under a demand signal.

        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.

      • deleteOccmDemandSignal

        Future<DeleteOccmDemandSignalResponse> deleteOccmDemandSignal​(DeleteOccmDemandSignalRequest request,
                                                              AsyncHandler<DeleteOccmDemandSignalRequest,​DeleteOccmDemandSignalResponse> handler)
        This is a DELETE API which deletes a demand signal with the provided demand signal ocid.
        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.

      • deleteOccmDemandSignalItem

        Future<DeleteOccmDemandSignalItemResponse> deleteOccmDemandSignalItem​(DeleteOccmDemandSignalItemRequest request,
                                                                      AsyncHandler<DeleteOccmDemandSignalItemRequest,​DeleteOccmDemandSignalItemResponse> handler)
        This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.
        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.

      • getOccmDemandSignal

        Future<GetOccmDemandSignalResponse> getOccmDemandSignal​(GetOccmDemandSignalRequest request,
                                                        AsyncHandler<GetOccmDemandSignalRequest,​GetOccmDemandSignalResponse> handler)
        This is a GET API which gets the detailed information about a specific demand signal.
        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.

      • getOccmDemandSignalItem

        Future<GetOccmDemandSignalItemResponse> getOccmDemandSignalItem​(GetOccmDemandSignalItemRequest request,
                                                                AsyncHandler<GetOccmDemandSignalItemRequest,​GetOccmDemandSignalItemResponse> handler)
        This is a GET API to get the details of a demand signal item resource representing the details of the resource demanded by you.
        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.

      • listOccmDemandSignalItems

        Future<ListOccmDemandSignalItemsResponse> listOccmDemandSignalItems​(ListOccmDemandSignalItemsRequest request,
                                                                    AsyncHandler<ListOccmDemandSignalItemsRequest,​ListOccmDemandSignalItemsResponse> handler)
        This API will list the detailed information about the resources demanded as part of the demand signal.
        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.

      • listOccmDemandSignals

        Future<ListOccmDemandSignalsResponse> listOccmDemandSignals​(ListOccmDemandSignalsRequest request,
                                                            AsyncHandler<ListOccmDemandSignalsRequest,​ListOccmDemandSignalsResponse> handler)
        This GET call is used to list all demand signals within the compartment passed as a query parameter.
        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.

      • updateOccmDemandSignal

        Future<UpdateOccmDemandSignalResponse> updateOccmDemandSignal​(UpdateOccmDemandSignalRequest request,
                                                              AsyncHandler<UpdateOccmDemandSignalRequest,​UpdateOccmDemandSignalResponse> handler)
        This is a PUT API which shall be used to update the metadata of the demand signal.
        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.