Package com.oracle.bmc.capacitymanagement

Interface DemandSignal

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DemandSignalClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20231107")
public interface DemandSignal
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. 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

      • bulkCreateOccmDemandSignalItem

        BulkCreateOccmDemandSignalItemResponse bulkCreateOccmDemandSignalItem​(BulkCreateOccmDemandSignalItemRequest request)
        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
        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.75.0/capacitymanagement/BulkCreateOccmDemandSignalItemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkCreateOccmDemandSignalItem API.

      • createOccmDemandSignal

        CreateOccmDemandSignalResponse createOccmDemandSignal​(CreateOccmDemandSignalRequest request)
        This is a post API to create occm demand signal.
        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.75.0/capacitymanagement/CreateOccmDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOccmDemandSignal API.

      • createOccmDemandSignalItem

        CreateOccmDemandSignalItemResponse createOccmDemandSignalItem​(CreateOccmDemandSignalItemRequest request)
        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
        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.75.0/capacitymanagement/CreateOccmDemandSignalItemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOccmDemandSignalItem API.

      • deleteOccmDemandSignal

        DeleteOccmDemandSignalResponse deleteOccmDemandSignal​(DeleteOccmDemandSignalRequest request)
        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
        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.75.0/capacitymanagement/DeleteOccmDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOccmDemandSignal API.

      • deleteOccmDemandSignalItem

        DeleteOccmDemandSignalItemResponse deleteOccmDemandSignalItem​(DeleteOccmDemandSignalItemRequest request)
        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
        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.75.0/capacitymanagement/DeleteOccmDemandSignalItemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOccmDemandSignalItem API.

      • getOccmDemandSignal

        GetOccmDemandSignalResponse getOccmDemandSignal​(GetOccmDemandSignalRequest request)
        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
        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.75.0/capacitymanagement/GetOccmDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOccmDemandSignal API.

      • getOccmDemandSignalItem

        GetOccmDemandSignalItemResponse getOccmDemandSignalItem​(GetOccmDemandSignalItemRequest request)
        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
        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.75.0/capacitymanagement/GetOccmDemandSignalItemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOccmDemandSignalItem API.

      • listOccmDemandSignalCatalogResources

        ListOccmDemandSignalCatalogResourcesResponse listOccmDemandSignalCatalogResources​(ListOccmDemandSignalCatalogResourcesRequest request)
        This API will list all the resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment.
        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.75.0/capacitymanagement/ListOccmDemandSignalCatalogResourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOccmDemandSignalCatalogResources API.

      • listOccmDemandSignalDeliveries

        ListOccmDemandSignalDeliveriesResponse listOccmDemandSignalDeliveries​(ListOccmDemandSignalDeliveriesRequest request)
        This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.
        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.75.0/capacitymanagement/ListOccmDemandSignalDeliveriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOccmDemandSignalDeliveries API.

      • listOccmDemandSignalItems

        ListOccmDemandSignalItemsResponse listOccmDemandSignalItems​(ListOccmDemandSignalItemsRequest request)
        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
        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.75.0/capacitymanagement/ListOccmDemandSignalItemsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOccmDemandSignalItems API.

      • listOccmDemandSignals

        ListOccmDemandSignalsResponse listOccmDemandSignals​(ListOccmDemandSignalsRequest request)
        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
        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.75.0/capacitymanagement/ListOccmDemandSignalsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOccmDemandSignals API.

      • updateOccmDemandSignal

        UpdateOccmDemandSignalResponse updateOccmDemandSignal​(UpdateOccmDemandSignalRequest request)
        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
        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.75.0/capacitymanagement/UpdateOccmDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOccmDemandSignal API.

      • updateOccmDemandSignalItem

        UpdateOccmDemandSignalItemResponse updateOccmDemandSignalItem​(UpdateOccmDemandSignalItemRequest request)
        This is a PUT API which can be used to update the demand signal item resource.
        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.75.0/capacitymanagement/UpdateOccmDemandSignalItemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOccmDemandSignalItem API.

      • getWaiters

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

      • getPaginators

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