Package com.oracle.bmc.distributeddatabase

Interface DistributedDbServiceAsync

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

    • 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 serice.

      • 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

      • configureDistributedDatabaseSharding

        Future<ConfigureDistributedDatabaseShardingResponse> configureDistributedDatabaseSharding​(ConfigureDistributedDatabaseShardingRequest request,
                                                                                          AsyncHandler<ConfigureDistributedDatabaseShardingRequest,​ConfigureDistributedDatabaseShardingResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getDistributedDatabase

        Future<GetDistributedDatabaseResponse> getDistributedDatabase​(GetDistributedDatabaseRequest request,
                                                              AsyncHandler<GetDistributedDatabaseRequest,​GetDistributedDatabaseResponse> handler)
        Gets the details of the Globally distributed database identified by given id.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • patchDistributedDatabase

        Future<PatchDistributedDatabaseResponse> patchDistributedDatabase​(PatchDistributedDatabaseRequest request,
                                                                  AsyncHandler<PatchDistributedDatabaseRequest,​PatchDistributedDatabaseResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • startDistributedDatabase

        Future<StartDistributedDatabaseResponse> startDistributedDatabase​(StartDistributedDatabaseRequest request,
                                                                  AsyncHandler<StartDistributedDatabaseRequest,​StartDistributedDatabaseResponse> handler)
        Start the shards, catalog and GSMs of Globally distributed database.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • stopDistributedDatabase

        Future<StopDistributedDatabaseResponse> stopDistributedDatabase​(StopDistributedDatabaseRequest request,
                                                                AsyncHandler<StopDistributedDatabaseRequest,​StopDistributedDatabaseResponse> handler)
        Stop the shards, catalog and GSM instances for the Globally distributed database.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.