Package com.oracle.bmc.ccdoffers

Interface CcdCommitments

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

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

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

      • 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

        CreateCcdCommitmentResponse createCcdCommitment​(CreateCcdCommitmentRequest request)
        Request to create a new CCD commitment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.98.0/ccdoffers/CreateCcdCommitmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCcdCommitment API.

      • deleteCcdCommitment

        DeleteCcdCommitmentResponse deleteCcdCommitment​(DeleteCcdCommitmentRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.98.0/ccdoffers/DeleteCcdCommitmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCcdCommitment API.

      • getCcdCommitment

        GetCcdCommitmentResponse getCcdCommitment​(GetCcdCommitmentRequest request)
        Gets the CCD commitment using the CCD commitment ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.98.0/ccdoffers/GetCcdCommitmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCcdCommitment API.

      • listCcdCommitments

        ListCcdCommitmentsResponse listCcdCommitments​(ListCcdCommitmentsRequest request)
        Lists the CCD commitments.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.98.0/ccdoffers/ListCcdCommitmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCcdCommitments API.

      • updateCcdCommitment

        UpdateCcdCommitmentResponse updateCcdCommitment​(UpdateCcdCommitmentRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.98.0/ccdoffers/UpdateCcdCommitmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCcdCommitment API.

      • getWaiters

        CcdCommitmentsWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        CcdCommitmentsPaginators getPaginators()
        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.

        Returns:
        The service paginators.