Package com.oracle.bmc.ccdoffers

Interface CcdCommitmentsAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    CcdCommitmentsAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240601")
public interface CcdCommitmentsAsync
extends AutoCloseable
    Use the Continuous Consumption Discounts API to manage continuous consumption discount operations.

    • 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

      • createCcdCommitment

        Future<CreateCcdCommitmentResponse> createCcdCommitment​(CreateCcdCommitmentRequest request,
                                                        AsyncHandler<CreateCcdCommitmentRequest,​CreateCcdCommitmentResponse> handler)
        Request to create a new CCD commitment.
        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.

      • deleteCcdCommitment

        Future<DeleteCcdCommitmentResponse> deleteCcdCommitment​(DeleteCcdCommitmentRequest request,
                                                        AsyncHandler<DeleteCcdCommitmentRequest,​DeleteCcdCommitmentResponse> handler)
        Terminates the CCD commitment.

        You can’t terminate an already canceled or ended commitment. If the CCD commitment has already started based on timeCcdCommitmentStarts, then you can only terminate within a week of its effective timeCcdCommitmentStarts time.

        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.

      • getCcdCommitment

        Future<GetCcdCommitmentResponse> getCcdCommitment​(GetCcdCommitmentRequest request,
                                                  AsyncHandler<GetCcdCommitmentRequest,​GetCcdCommitmentResponse> handler)
        Gets the CCD commitment using the CCD commitment ID.
        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.

      • listCcdCommitments

        Future<ListCcdCommitmentsResponse> listCcdCommitments​(ListCcdCommitmentsRequest request,
                                                      AsyncHandler<ListCcdCommitmentsRequest,​ListCcdCommitmentsResponse> handler)
        Lists the CCD commitments.
        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.

      • updateCcdCommitment

        Future<UpdateCcdCommitmentResponse> updateCcdCommitment​(UpdateCcdCommitmentRequest request,
                                                        AsyncHandler<UpdateCcdCommitmentRequest,​UpdateCcdCommitmentResponse> handler)
        Updates the free-form tags, defined tags, or both on a CCD commitment.

        Commercial commitment attributes are immutable.

        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.