Package com.oracle.bmc.demandsignal

Interface OccDemandSignal

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OccDemandSignalClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240430")
public interface OccDemandSignal
extends AutoCloseable
    Use the OCI Control Center Demand Signal API to manage Demand Signals.

    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

      • changeOccDemandSignalCompartment

        ChangeOccDemandSignalCompartmentResponse changeOccDemandSignalCompartment​(ChangeOccDemandSignalCompartmentRequest request)
        Moves a OccDemandSignal into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources to a Different 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.63.0/demandsignal/ChangeOccDemandSignalCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeOccDemandSignalCompartment API.

      • createOccDemandSignal

        CreateOccDemandSignalResponse createOccDemandSignal​(CreateOccDemandSignalRequest request)
        Creates a OccDemandSignal.
        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.63.0/demandsignal/CreateOccDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOccDemandSignal API.

      • deleteOccDemandSignal

        DeleteOccDemandSignalResponse deleteOccDemandSignal​(DeleteOccDemandSignalRequest request)
        Deletes a OccDemandSignal.
        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.63.0/demandsignal/DeleteOccDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOccDemandSignal API.

      • getOccDemandSignal

        GetOccDemandSignalResponse getOccDemandSignal​(GetOccDemandSignalRequest request)
        Gets information about a OccDemandSignal.
        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.63.0/demandsignal/GetOccDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOccDemandSignal API.

      • listOccDemandSignals

        ListOccDemandSignalsResponse listOccDemandSignals​(ListOccDemandSignalsRequest request)
        Gets a list of OccDemandSignals.
        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.63.0/demandsignal/ListOccDemandSignalsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOccDemandSignals API.

      • patchOccDemandSignal

        PatchOccDemandSignalResponse patchOccDemandSignal​(PatchOccDemandSignalRequest request)
        Updates the data of an OccDemandSignal.
        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.63.0/demandsignal/PatchOccDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PatchOccDemandSignal API.

      • updateOccDemandSignal

        UpdateOccDemandSignalResponse updateOccDemandSignal​(UpdateOccDemandSignalRequest request)
        Updates a OccDemandSignal.
        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.63.0/demandsignal/UpdateOccDemandSignalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOccDemandSignal API.

      • getWaiters

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

      • getPaginators

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