Package com.oracle.bmc.globallydistributeddatabase

Interface ShardedDatabaseService

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ShardedDatabaseServiceClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230301")
public interface ShardedDatabaseService
extends AutoCloseable
    Use the Globally Distributed Database service APIs to create and manage 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

      • changePrivateEndpointCompartment

        ChangePrivateEndpointCompartmentResponse changePrivateEndpointCompartment​(ChangePrivateEndpointCompartmentRequest request)
        Move the private endpoint 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/globallydistributeddatabase/ChangePrivateEndpointCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangePrivateEndpointCompartment API.

      • changeShardedDatabaseCompartment

        ChangeShardedDatabaseCompartmentResponse changeShardedDatabaseCompartment​(ChangeShardedDatabaseCompartmentRequest request)
        Move the sharded database 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/globallydistributeddatabase/ChangeShardedDatabaseCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeShardedDatabaseCompartment API.

      • configureShardedDatabaseGsms

        ConfigureShardedDatabaseGsmsResponse configureShardedDatabaseGsms​(ConfigureShardedDatabaseGsmsRequest request)
        Configure new Global Service Manager(GSM aka shard manager) instances for the sharded database.

        Specify the names of old GSM instances that need to be replaced via parameter oldGsmNames in the request payload. Also specify whether rotated GSM instances shall be provisioned with latest image of GSM software or the image used by existing GSM instances shall be used.

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

      • configureSharding

        ConfigureShardingResponse configureSharding​(ConfigureShardingRequest request)
        Once all components of sharded database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the sharded database.

        Note that this ‘ConfigureSharding’ API also needs to be invoked after successfully adding a new shard to the sharded 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 sharded 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/globallydistributeddatabase/ConfigureShardingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ConfigureSharding API.

      • createPrivateEndpoint

        CreatePrivateEndpointResponse createPrivateEndpoint​(CreatePrivateEndpointRequest request)
        Creates a PrivateEndpoint.
        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/globallydistributeddatabase/CreatePrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePrivateEndpoint API.

      • createShardedDatabase

        CreateShardedDatabaseResponse createShardedDatabase​(CreateShardedDatabaseRequest request)
        Creates a Sharded 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/globallydistributeddatabase/CreateShardedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateShardedDatabase API.

      • deletePrivateEndpoint

        DeletePrivateEndpointResponse deletePrivateEndpoint​(DeletePrivateEndpointRequest request)
        Delete the given private endpoint.
        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/globallydistributeddatabase/DeletePrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePrivateEndpoint API.

      • deleteShardedDatabase

        DeleteShardedDatabaseResponse deleteShardedDatabase​(DeleteShardedDatabaseRequest request)
        Terminate the given sharded 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/globallydistributeddatabase/DeleteShardedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteShardedDatabase API.

      • downloadGsmCertificateSigningRequest

        DownloadGsmCertificateSigningRequestResponse downloadGsmCertificateSigningRequest​(DownloadGsmCertificateSigningRequestRequest 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 sharded 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/globallydistributeddatabase/DownloadGsmCertificateSigningRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DownloadGsmCertificateSigningRequest API.

      • fetchConnectionString

        FetchConnectionStringResponse fetchConnectionString​(FetchConnectionStringRequest request)
        Gets the Sharded Database Connection Strings.
        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/globallydistributeddatabase/FetchConnectionStringExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use FetchConnectionString API.

      • fetchShardableCloudAutonomousVmClusters

        FetchShardableCloudAutonomousVmClustersResponse fetchShardableCloudAutonomousVmClusters​(FetchShardableCloudAutonomousVmClustersRequest request)
        List of cloudAutonomousVMClusters for the given tenancy, that can be sharded.
        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/globallydistributeddatabase/FetchShardableCloudAutonomousVmClustersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use FetchShardableCloudAutonomousVmClusters API.

      • generateGsmCertificateSigningRequest

        GenerateGsmCertificateSigningRequestResponse generateGsmCertificateSigningRequest​(GenerateGsmCertificateSigningRequestRequest request)
        Generate the certificate signing request for GSM instances of the sharded 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/globallydistributeddatabase/GenerateGsmCertificateSigningRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GenerateGsmCertificateSigningRequest API.

      • generateWallet

        GenerateWalletResponse generateWallet​(GenerateWalletRequest request)
        Generate the wallet associated with sharded 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/globallydistributeddatabase/GenerateWalletExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GenerateWallet API.

      • getPrivateEndpoint

        GetPrivateEndpointResponse getPrivateEndpoint​(GetPrivateEndpointRequest request)
        Get the PrivateEndpoint 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/globallydistributeddatabase/GetPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPrivateEndpoint API.

      • getShardedDatabase

        GetShardedDatabaseResponse getShardedDatabase​(GetShardedDatabaseRequest request)
        Gets the details of the Sharded 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/globallydistributeddatabase/GetShardedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetShardedDatabase API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets details of the work request with the 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/globallydistributeddatabase/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listPrivateEndpoints

        ListPrivateEndpointsResponse listPrivateEndpoints​(ListPrivateEndpointsRequest request)
        List of PrivateEndpoints.
        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/globallydistributeddatabase/ListPrivateEndpointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPrivateEndpoints API.

      • listShardedDatabases

        ListShardedDatabasesResponse listShardedDatabases​(ListShardedDatabasesRequest request)
        List of Sharded 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/globallydistributeddatabase/ListShardedDatabasesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListShardedDatabases API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Returns a (paginated) list of errors for the work request with the 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/globallydistributeddatabase/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.

      • listWorkRequestLogs

        ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Returns a (paginated) list of logs for the work request with the 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/globallydistributeddatabase/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists the work requests in a 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/globallydistributeddatabase/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • patchShardedDatabase

        PatchShardedDatabaseResponse patchShardedDatabase​(PatchShardedDatabaseRequest request)
        Patch operation to add, remove or update shards to the sharded 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/globallydistributeddatabase/PatchShardedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PatchShardedDatabase API.

      • prevalidateShardedDatabase

        PrevalidateShardedDatabaseResponse prevalidateShardedDatabase​(PrevalidateShardedDatabaseRequest request)
        Sharded database pre-validation request.
        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/globallydistributeddatabase/PrevalidateShardedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PrevalidateShardedDatabase API.

      • reinstateProxyInstance

        ReinstateProxyInstanceResponse reinstateProxyInstance​(ReinstateProxyInstanceRequest request)
        API to reinstate the proxy instances associated with the private endpoint.
        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/globallydistributeddatabase/ReinstateProxyInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ReinstateProxyInstance API.

      • startShardedDatabase

        StartShardedDatabaseResponse startShardedDatabase​(StartShardedDatabaseRequest request)
        Start the shards, catalog and GSMs of Sharded 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/globallydistributeddatabase/StartShardedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartShardedDatabase API.

      • stopShardedDatabase

        StopShardedDatabaseResponse stopShardedDatabase​(StopShardedDatabaseRequest request)
        Stop the shards, catalog and GSM instances for the sharded 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/globallydistributeddatabase/StopShardedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopShardedDatabase API.

      • updatePrivateEndpoint

        UpdatePrivateEndpointResponse updatePrivateEndpoint​(UpdatePrivateEndpointRequest request)
        Updates the configuration of privateendpoint.
        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/globallydistributeddatabase/UpdatePrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePrivateEndpoint API.

      • updateShardedDatabase

        UpdateShardedDatabaseResponse updateShardedDatabase​(UpdateShardedDatabaseRequest request)
        Updates the configuration of sharded 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/globallydistributeddatabase/UpdateShardedDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateShardedDatabase API.

      • uploadSignedCertificateAndGenerateWallet

        UploadSignedCertificateAndGenerateWalletResponse uploadSignedCertificateAndGenerateWallet​(UploadSignedCertificateAndGenerateWalletRequest request)
        Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the sharded 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/globallydistributeddatabase/UploadSignedCertificateAndGenerateWalletExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UploadSignedCertificateAndGenerateWallet API.

      • validateNetwork

        ValidateNetworkResponse validateNetwork​(ValidateNetworkRequest request)
        Validate the network connectivity between components of sharded 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/globallydistributeddatabase/ValidateNetworkExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateNetwork API.

      • getWaiters

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

      • getPaginators

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