Package com.oracle.bmc.distributeddatabase

Interface DistributedDbService

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DistributedDbServiceClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250101")
public interface DistributedDbService
extends AutoCloseable
    Use the Globally Distributed Database service APIs to create and manage the Globally distributed databases.

    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

      • addDistributedDatabaseGdsControlNode

        AddDistributedDatabaseGdsControlNodeResponse addDistributedDatabaseGdsControlNode​(AddDistributedDatabaseGdsControlNodeRequest request)
        Add new Global database services control(GDS CTL) node for the Globally distributed database.
        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/distributeddatabase/AddDistributedDatabaseGdsControlNodeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDistributedDatabaseGdsControlNode API.

      • changeDistributedDatabaseCompartment

        ChangeDistributedDatabaseCompartmentResponse changeDistributedDatabaseCompartment​(ChangeDistributedDatabaseCompartmentRequest request)
        Move the Globally distributed database and its dependent resources to the specified 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/distributeddatabase/ChangeDistributedDatabaseCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDistributedDatabaseCompartment API.

      • changeDistributedDbBackupConfig

        ChangeDistributedDbBackupConfigResponse changeDistributedDbBackupConfig​(ChangeDistributedDbBackupConfigRequest request)
        Change the DbBackupConfig for the Globally distributed database.
        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/distributeddatabase/ChangeDistributedDbBackupConfigExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDistributedDbBackupConfig API.

      • configureDistributedDatabaseGsms

        ConfigureDistributedDatabaseGsmsResponse configureDistributedDatabaseGsms​(ConfigureDistributedDatabaseGsmsRequest request)
        Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.
        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/distributeddatabase/ConfigureDistributedDatabaseGsmsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ConfigureDistributedDatabaseGsms API.

      • configureDistributedDatabaseSharding

        ConfigureDistributedDatabaseShardingResponse configureDistributedDatabaseSharding​(ConfigureDistributedDatabaseShardingRequest request)
        Once all components of Globally distributed database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the Globally distributed database.

        Note that this ‘ConfigureSharding’ API also needs to be invoked after successfully adding a new shard to the Globally distributed database using PATCH api. If this API is not invoked after successfully adding a new shard, then that new shard will not be a participant in sharding topology of the Globally distributed database.

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

      • createDistributedDatabase

        CreateDistributedDatabaseResponse createDistributedDatabase​(CreateDistributedDatabaseRequest request)
        Creates a Globally distributed database.
        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/distributeddatabase/CreateDistributedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDistributedDatabase API.

      • deleteDistributedDatabase

        DeleteDistributedDatabaseResponse deleteDistributedDatabase​(DeleteDistributedDatabaseRequest request)
        Terminate the given Globally distributed databases.
        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/distributeddatabase/DeleteDistributedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDistributedDatabase API.

      • downloadDistributedDatabaseGsmCertificateSigningRequest

        DownloadDistributedDatabaseGsmCertificateSigningRequestResponse downloadDistributedDatabaseGsmCertificateSigningRequest​(DownloadDistributedDatabaseGsmCertificateSigningRequestRequest request)
        Generate the common certificate signing request for GSMs.

        Download the .csr file from API response. Users can use this .csr file to generate the CA signed certificate, and as a next step use ‘uploadSignedCertificateAndGenerateWallet’ API to upload the CA signed certificate to GSM, and generate wallets for the GSM instances of the Globally distributed database.

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

      • generateDistributedDatabaseGsmCertificateSigningRequest

        GenerateDistributedDatabaseGsmCertificateSigningRequestResponse generateDistributedDatabaseGsmCertificateSigningRequest​(GenerateDistributedDatabaseGsmCertificateSigningRequestRequest request)
        Generate the certificate signing request for GSM instances of the Globally distributed database.

        Once certificate signing request is generated, then customers can download the certificate signing request using ‘downloadGsmCertificateSigningRequest’ api call.

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

      • generateDistributedDatabaseWallet

        GenerateDistributedDatabaseWalletResponse generateDistributedDatabaseWallet​(GenerateDistributedDatabaseWalletRequest request)
        Generate the wallet associated with Globally distributed database.
        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/distributeddatabase/GenerateDistributedDatabaseWalletExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GenerateDistributedDatabaseWallet API.

      • getDistributedDatabase

        GetDistributedDatabaseResponse getDistributedDatabase​(GetDistributedDatabaseRequest request)
        Gets the details of the Globally distributed database identified by given 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.75.0/distributeddatabase/GetDistributedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDistributedDatabase API.

      • listDistributedDatabases

        ListDistributedDatabasesResponse listDistributedDatabases​(ListDistributedDatabasesRequest request)
        List of Globally distributed databases.
        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/distributeddatabase/ListDistributedDatabasesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDistributedDatabases API.

      • patchDistributedDatabase

        PatchDistributedDatabaseResponse patchDistributedDatabase​(PatchDistributedDatabaseRequest request)
        Patch operation to add, remove or update shards to the Globally distributed database topology.

        In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.

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

      • rotateDistributedDatabasePasswords

        RotateDistributedDatabasePasswordsResponse rotateDistributedDatabasePasswords​(RotateDistributedDatabasePasswordsRequest request)
        Rotate passwords for different components of the Globally distributed database.
        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/distributeddatabase/RotateDistributedDatabasePasswordsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RotateDistributedDatabasePasswords API.

      • startDistributedDatabase

        StartDistributedDatabaseResponse startDistributedDatabase​(StartDistributedDatabaseRequest request)
        Start the shards, catalog and GSMs of Globally distributed database.
        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/distributeddatabase/StartDistributedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartDistributedDatabase API.

      • stopDistributedDatabase

        StopDistributedDatabaseResponse stopDistributedDatabase​(StopDistributedDatabaseRequest request)
        Stop the shards, catalog and GSM instances for the Globally distributed database.
        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/distributeddatabase/StopDistributedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopDistributedDatabase API.

      • updateDistributedDatabase

        UpdateDistributedDatabaseResponse updateDistributedDatabase​(UpdateDistributedDatabaseRequest request)
        Updates the configuration of the Globally distributed database.
        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/distributeddatabase/UpdateDistributedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDistributedDatabase API.

      • uploadDistributedDatabaseSignedCertificateAndGenerateWallet

        UploadDistributedDatabaseSignedCertificateAndGenerateWalletResponse uploadDistributedDatabaseSignedCertificateAndGenerateWallet​(UploadDistributedDatabaseSignedCertificateAndGenerateWalletRequest request)
        Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the Globally distributed database.

        Customer shall provide the CA signed certificate key details by adding the certificate in request body.

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

      • validateDistributedDatabaseNetwork

        ValidateDistributedDatabaseNetworkResponse validateDistributedDatabaseNetwork​(ValidateDistributedDatabaseNetworkRequest request)
        Validate the network connectivity between components of the globally distributed database.
        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/distributeddatabase/ValidateDistributedDatabaseNetworkExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateDistributedDatabaseNetwork API.

      • getWaiters

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

      • getPaginators

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