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 Summary

Modifier and Type	Method	Description
Future<AddDistributedDatabaseGdsControlNodeResponse>	addDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest request, AsyncHandler<AddDistributedDatabaseGdsControlNodeRequest,AddDistributedDatabaseGdsControlNodeResponse> handler)	Add new Global database services control(GDS CTL) node for the Globally distributed database.
Future<ChangeDistributedDatabaseCompartmentResponse>	changeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest request, AsyncHandler<ChangeDistributedDatabaseCompartmentRequest,ChangeDistributedDatabaseCompartmentResponse> handler)	Move the Globally distributed database and its dependent resources to the specified compartment.
Future<ChangeDistributedDbBackupConfigResponse>	changeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest request, AsyncHandler<ChangeDistributedDbBackupConfigRequest,ChangeDistributedDbBackupConfigResponse> handler)	Change the DbBackupConfig for the Globally distributed database.
Future<ConfigureDistributedDatabaseGsmsResponse>	configureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest request, AsyncHandler<ConfigureDistributedDatabaseGsmsRequest,ConfigureDistributedDatabaseGsmsResponse> handler)	Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.
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.
Future<CreateDistributedDatabaseResponse>	createDistributedDatabase(CreateDistributedDatabaseRequest request, AsyncHandler<CreateDistributedDatabaseRequest,CreateDistributedDatabaseResponse> handler)	Creates a Globally distributed database.
Future<DeleteDistributedDatabaseResponse>	deleteDistributedDatabase(DeleteDistributedDatabaseRequest request, AsyncHandler<DeleteDistributedDatabaseRequest,DeleteDistributedDatabaseResponse> handler)	Terminate the given Globally distributed databases.
Future<DownloadDistributedDatabaseGsmCertificateSigningRequestResponse>	downloadDistributedDatabaseGsmCertificateSigningRequest(DownloadDistributedDatabaseGsmCertificateSigningRequestRequest request, AsyncHandler<DownloadDistributedDatabaseGsmCertificateSigningRequestRequest,DownloadDistributedDatabaseGsmCertificateSigningRequestResponse> handler)	Generate the common certificate signing request for GSMs.
Future<GenerateDistributedDatabaseGsmCertificateSigningRequestResponse>	generateDistributedDatabaseGsmCertificateSigningRequest(GenerateDistributedDatabaseGsmCertificateSigningRequestRequest request, AsyncHandler<GenerateDistributedDatabaseGsmCertificateSigningRequestRequest,GenerateDistributedDatabaseGsmCertificateSigningRequestResponse> handler)	Generate the certificate signing request for GSM instances of the Globally distributed database.
Future<GenerateDistributedDatabaseWalletResponse>	generateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest request, AsyncHandler<GenerateDistributedDatabaseWalletRequest,GenerateDistributedDatabaseWalletResponse> handler)	Generate the wallet associated with Globally distributed database.
Future<GetDistributedDatabaseResponse>	getDistributedDatabase(GetDistributedDatabaseRequest request, AsyncHandler<GetDistributedDatabaseRequest,GetDistributedDatabaseResponse> handler)	Gets the details of the Globally distributed database identified by given id.
String	getEndpoint()	Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListDistributedDatabasesResponse>	listDistributedDatabases(ListDistributedDatabasesRequest request, AsyncHandler<ListDistributedDatabasesRequest,ListDistributedDatabasesResponse> handler)	List of Globally distributed databases.
Future<PatchDistributedDatabaseResponse>	patchDistributedDatabase(PatchDistributedDatabaseRequest request, AsyncHandler<PatchDistributedDatabaseRequest,PatchDistributedDatabaseResponse> handler)	Patch operation to add, remove or update shards to the Globally distributed database topology.
void	refreshClient()	Rebuilds the client from scratch.
Future<RotateDistributedDatabasePasswordsResponse>	rotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request, AsyncHandler<RotateDistributedDatabasePasswordsRequest,RotateDistributedDatabasePasswordsResponse> handler)	Rotate passwords for different components of the Globally distributed database.
void	setEndpoint(String endpoint)	Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
Future<StartDistributedDatabaseResponse>	startDistributedDatabase(StartDistributedDatabaseRequest request, AsyncHandler<StartDistributedDatabaseRequest,StartDistributedDatabaseResponse> handler)	Start the shards, catalog and GSMs of Globally distributed database.
Future<StopDistributedDatabaseResponse>	stopDistributedDatabase(StopDistributedDatabaseRequest request, AsyncHandler<StopDistributedDatabaseRequest,StopDistributedDatabaseResponse> handler)	Stop the shards, catalog and GSM instances for the Globally distributed database.
Future<UpdateDistributedDatabaseResponse>	updateDistributedDatabase(UpdateDistributedDatabaseRequest request, AsyncHandler<UpdateDistributedDatabaseRequest,UpdateDistributedDatabaseResponse> handler)	Updates the configuration of the Globally distributed database.
Future<UploadDistributedDatabaseSignedCertificateAndGenerateWalletResponse>	uploadDistributedDatabaseSignedCertificateAndGenerateWallet(UploadDistributedDatabaseSignedCertificateAndGenerateWalletRequest request, AsyncHandler<UploadDistributedDatabaseSignedCertificateAndGenerateWalletRequest,UploadDistributedDatabaseSignedCertificateAndGenerateWalletResponse> handler)	Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the Globally distributed database.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)	Determines whether realm specific endpoint should be used or not.
Future<ValidateDistributedDatabaseNetworkResponse>	validateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request, AsyncHandler<ValidateDistributedDatabaseNetworkRequest,ValidateDistributedDatabaseNetworkResponse> handler)	Validate the network connectivity between components of the globally distributed database.

Methods inherited from interface java.lang.AutoCloseable

close

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

addDistributedDatabaseGdsControlNode

Future<AddDistributedDatabaseGdsControlNodeResponse> addDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest request,
                                                                                          AsyncHandler<AddDistributedDatabaseGdsControlNodeRequest,AddDistributedDatabaseGdsControlNodeResponse> handler)

Add new Global database services control(GDS CTL) node 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.

changeDistributedDatabaseCompartment

Future<ChangeDistributedDatabaseCompartmentResponse> changeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest request,
                                                                                          AsyncHandler<ChangeDistributedDatabaseCompartmentRequest,ChangeDistributedDatabaseCompartmentResponse> handler)

Move the Globally distributed database and its dependent resources to the specified compartment.

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.

changeDistributedDbBackupConfig

Future<ChangeDistributedDbBackupConfigResponse> changeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest request,
                                                                                AsyncHandler<ChangeDistributedDbBackupConfigRequest,ChangeDistributedDbBackupConfigResponse> handler)

Change the DbBackupConfig 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.

configureDistributedDatabaseGsms

Future<ConfigureDistributedDatabaseGsmsResponse> configureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest request,
                                                                                  AsyncHandler<ConfigureDistributedDatabaseGsmsRequest,ConfigureDistributedDatabaseGsmsResponse> handler)

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

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.

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.

createDistributedDatabase

Future<CreateDistributedDatabaseResponse> createDistributedDatabase(CreateDistributedDatabaseRequest request,
                                                                    AsyncHandler<CreateDistributedDatabaseRequest,CreateDistributedDatabaseResponse> handler)

Creates a 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.

deleteDistributedDatabase

Future<DeleteDistributedDatabaseResponse> deleteDistributedDatabase(DeleteDistributedDatabaseRequest request,
                                                                    AsyncHandler<DeleteDistributedDatabaseRequest,DeleteDistributedDatabaseResponse> handler)

Terminate the given Globally distributed databases.

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.

downloadDistributedDatabaseGsmCertificateSigningRequest

Future<DownloadDistributedDatabaseGsmCertificateSigningRequestResponse> downloadDistributedDatabaseGsmCertificateSigningRequest(DownloadDistributedDatabaseGsmCertificateSigningRequestRequest request,
                                                                                                                                AsyncHandler<DownloadDistributedDatabaseGsmCertificateSigningRequestRequest,DownloadDistributedDatabaseGsmCertificateSigningRequestResponse> handler)

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

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.

generateDistributedDatabaseGsmCertificateSigningRequest

Future<GenerateDistributedDatabaseGsmCertificateSigningRequestResponse> generateDistributedDatabaseGsmCertificateSigningRequest(GenerateDistributedDatabaseGsmCertificateSigningRequestRequest request,
                                                                                                                                AsyncHandler<GenerateDistributedDatabaseGsmCertificateSigningRequestRequest,GenerateDistributedDatabaseGsmCertificateSigningRequestResponse> handler)

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

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.

generateDistributedDatabaseWallet

Future<GenerateDistributedDatabaseWalletResponse> generateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest request,
                                                                                    AsyncHandler<GenerateDistributedDatabaseWalletRequest,GenerateDistributedDatabaseWalletResponse> handler)

Generate the wallet associated with 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.

listDistributedDatabases

Future<ListDistributedDatabasesResponse> listDistributedDatabases(ListDistributedDatabasesRequest request,
                                                                  AsyncHandler<ListDistributedDatabasesRequest,ListDistributedDatabasesResponse> handler)

List of Globally distributed databases.

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.

rotateDistributedDatabasePasswords

Future<RotateDistributedDatabasePasswordsResponse> rotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request,
                                                                                      AsyncHandler<RotateDistributedDatabasePasswordsRequest,RotateDistributedDatabasePasswordsResponse> handler)

Rotate passwords for different components 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.

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.

updateDistributedDatabase

Future<UpdateDistributedDatabaseResponse> updateDistributedDatabase(UpdateDistributedDatabaseRequest request,
                                                                    AsyncHandler<UpdateDistributedDatabaseRequest,UpdateDistributedDatabaseResponse> handler)

Updates the configuration 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.

uploadDistributedDatabaseSignedCertificateAndGenerateWallet

Future<UploadDistributedDatabaseSignedCertificateAndGenerateWalletResponse> uploadDistributedDatabaseSignedCertificateAndGenerateWallet(UploadDistributedDatabaseSignedCertificateAndGenerateWalletRequest request,
                                                                                                                                        AsyncHandler<UploadDistributedDatabaseSignedCertificateAndGenerateWalletRequest,UploadDistributedDatabaseSignedCertificateAndGenerateWalletResponse> handler)

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

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.

validateDistributedDatabaseNetwork

Future<ValidateDistributedDatabaseNetworkResponse> validateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request,
                                                                                      AsyncHandler<ValidateDistributedDatabaseNetworkRequest,ValidateDistributedDatabaseNetworkResponse> handler)

Validate the network connectivity between components 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.