Package com.oracle.bmc.opensearch

Interface OpensearchClusterBackup

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OpensearchClusterBackupClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public interface OpensearchClusterBackup
extends AutoCloseable
    The OpenSearch service API provides access to OCI Search Service with OpenSearch.

    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

      • deleteOpensearchClusterBackup

        DeleteOpensearchClusterBackupResponse deleteOpensearchClusterBackup​(DeleteOpensearchClusterBackupRequest request)
        Deletes a OpensearchClusterBackup resource by identifier
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/opensearch/DeleteOpensearchClusterBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOpensearchClusterBackup API.

      • getOpensearchClusterBackup

        GetOpensearchClusterBackupResponse getOpensearchClusterBackup​(GetOpensearchClusterBackupRequest request)
        Gets a OpensearchClusterBackup by identifier
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/opensearch/GetOpensearchClusterBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOpensearchClusterBackup API.

      • listOpensearchClusterBackups

        ListOpensearchClusterBackupsResponse listOpensearchClusterBackups​(ListOpensearchClusterBackupsRequest request)
        Returns a list of OpensearchClusterBackups.
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/opensearch/ListOpensearchClusterBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOpensearchClusterBackups API.

      • updateOpensearchClusterBackup

        UpdateOpensearchClusterBackupResponse updateOpensearchClusterBackup​(UpdateOpensearchClusterBackupRequest request)
        Updates the OpensearchClusterBackup
        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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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/opensearch/UpdateOpensearchClusterBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOpensearchClusterBackup API.

      • getWaiters

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

      • getPaginators

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