Package com.oracle.bmc.capacitymanagement

Interface InternalDemandSignal

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

      • createInternalOccmDemandSignalDelivery

        CreateInternalOccmDemandSignalDeliveryResponse createInternalOccmDemandSignalDelivery​(CreateInternalOccmDemandSignalDeliveryRequest request)
        This is a post API which is used to create a demand signal delivery resource.

        operationId: CreateInternalOccmDemandSignalDelivery summary: A post call to create a demand signal delivery.

        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/CreateInternalOccmDemandSignalDeliveryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateInternalOccmDemandSignalDelivery API.

      • deleteInternalOccmDemandSignalDelivery

        DeleteInternalOccmDemandSignalDeliveryResponse deleteInternalOccmDemandSignalDelivery​(DeleteInternalOccmDemandSignalDeliveryRequest request)
        This is an internal DELETE API which is used to delete a demand signal delivery 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/DeleteInternalOccmDemandSignalDeliveryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteInternalOccmDemandSignalDelivery API.

      • getInternalOccmDemandSignal

        GetInternalOccmDemandSignalResponse getInternalOccmDemandSignal​(GetInternalOccmDemandSignalRequest request)
        This is an internal 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/GetInternalOccmDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInternalOccmDemandSignal API.

      • getInternalOccmDemandSignalCatalog

        GetInternalOccmDemandSignalCatalogResponse getInternalOccmDemandSignalCatalog​(GetInternalOccmDemandSignalCatalogRequest request)
        This API helps in getting the details about a specific occm demand signal catalog.
        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/GetInternalOccmDemandSignalCatalogExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInternalOccmDemandSignalCatalog API.

      • getInternalOccmDemandSignalDelivery

        GetInternalOccmDemandSignalDeliveryResponse getInternalOccmDemandSignalDelivery​(GetInternalOccmDemandSignalDeliveryRequest request)
        This is an internal GET API to get the details of a demand signal delivery resource corresponding to a demand signal item.
        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/GetInternalOccmDemandSignalDeliveryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInternalOccmDemandSignalDelivery API.

      • listInternalOccmDemandSignalCatalogResources

        ListInternalOccmDemandSignalCatalogResourcesResponse listInternalOccmDemandSignalCatalogResources​(ListInternalOccmDemandSignalCatalogResourcesRequest request)
        This API will list all the resources across all demand signal catalogs for a given namespace and customer group.
        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/ListInternalOccmDemandSignalCatalogResourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInternalOccmDemandSignalCatalogResources API.

      • listInternalOccmDemandSignalCatalogs

        ListInternalOccmDemandSignalCatalogsResponse listInternalOccmDemandSignalCatalogs​(ListInternalOccmDemandSignalCatalogsRequest request)
        This API will list demand signal catalogs for a given customer group.
        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/ListInternalOccmDemandSignalCatalogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInternalOccmDemandSignalCatalogs API.

      • listInternalOccmDemandSignalDeliveries

        ListInternalOccmDemandSignalDeliveriesResponse listInternalOccmDemandSignalDeliveries​(ListInternalOccmDemandSignalDeliveriesRequest request)
        This GET call is used to list all demand signal delivery resources within the customer group 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/ListInternalOccmDemandSignalDeliveriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInternalOccmDemandSignalDeliveries API.

      • listInternalOccmDemandSignalItems

        ListInternalOccmDemandSignalItemsResponse listInternalOccmDemandSignalItems​(ListInternalOccmDemandSignalItemsRequest request)
        This internal 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/ListInternalOccmDemandSignalItemsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInternalOccmDemandSignalItems API.

      • listInternalOccmDemandSignals

        ListInternalOccmDemandSignalsResponse listInternalOccmDemandSignals​(ListInternalOccmDemandSignalsRequest request)
        This is an internal 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/ListInternalOccmDemandSignalsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInternalOccmDemandSignals API.

      • updateInternalOccmDemandSignal

        UpdateInternalOccmDemandSignalResponse updateInternalOccmDemandSignal​(UpdateInternalOccmDemandSignalRequest request)
        This is a internal 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/UpdateInternalOccmDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateInternalOccmDemandSignal API.

      • updateInternalOccmDemandSignalDelivery

        UpdateInternalOccmDemandSignalDeliveryResponse updateInternalOccmDemandSignalDelivery​(UpdateInternalOccmDemandSignalDeliveryRequest request)
        This is an internal PUT API which is used to update the demand signal delivery 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/UpdateInternalOccmDemandSignalDeliveryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateInternalOccmDemandSignalDelivery API.

      • getWaiters

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

      • getPaginators

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