Package com.oracle.bmc.distributeddatabase

Class DistributedDbServiceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.distributeddatabase.DistributedDbServiceAsyncClient

All Implemented Interfaces:

DistributedDbServiceAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20250101")
public class DistributedDbServiceAsyncClient
extends BaseAsyncClient
implements DistributedDbServiceAsync

Async client implementation for DistributedDbService service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistributedDbServiceAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for DistributedDbService.

Constructor Summary

Constructors

Constructor	Description
DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

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.
static DistributedDbServiceAsyncClient.Builder	builder()	Create a builder for this client.
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.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
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.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
Future<GetDistributedDatabaseResponse>	getDistributedDatabase(GetDistributedDatabaseRequest request, AsyncHandler<GetDistributedDatabaseRequest,GetDistributedDatabaseResponse> handler)	Gets the details of the Globally distributed database identified by given id.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
Future<RotateDistributedDatabasePasswordsResponse>	rotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request, AsyncHandler<RotateDistributedDatabasePasswordsRequest,RotateDistributedDatabasePasswordsResponse> handler)	Rotate passwords for different components of the Globally distributed database.
void	setEndpoint(String endpoint)
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.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
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 useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.
Future<ValidateDistributedDatabaseNetworkResponse>	validateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request, AsyncHandler<ValidateDistributedDatabaseNetworkRequest,ValidateDistributedDatabaseNetworkResponse> handler)	Validate the network connectivity between components of the globally distributed database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.distributeddatabase.DistributedDbServiceAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DistributedDbService.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

DistributedDbServiceAsyncClient

@Deprecated
public DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DistributedDbServiceAsyncClient

@Deprecated
public DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DistributedDbServiceAsyncClient

@Deprecated
public DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DistributedDbServiceAsyncClient

@Deprecated
public DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DistributedDbServiceAsyncClient

@Deprecated
public DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DistributedDbServiceAsyncClient

@Deprecated
public DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       List<ClientConfigurator> additionalClientConfigurators,
                                       String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

DistributedDbServiceAsyncClient

@Deprecated
public DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                       List<ClientConfigurator> additionalClientConfigurators,
                                       String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static DistributedDbServiceAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DistributedDbServiceAsync

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.

Specified by:

setRegion in interface DistributedDbServiceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DistributedDbServiceAsync

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.

Specified by:

setRegion in interface DistributedDbServiceAsync

Parameters:

regionId - The public region ID.

addDistributedDatabaseGdsControlNode

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

Description copied from interface: DistributedDbServiceAsync

Add new Global database services control(GDS CTL) node for the Globally distributed database.

Specified by:

addDistributedDatabaseGdsControlNode in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

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

Specified by:

changeDistributedDatabaseCompartment in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

Change the DbBackupConfig for the Globally distributed database.

Specified by:

changeDistributedDbBackupConfig in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.

Specified by:

configureDistributedDatabaseGsms in interface DistributedDbServiceAsync

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

public Future<ConfigureDistributedDatabaseShardingResponse> configureDistributedDatabaseSharding(ConfigureDistributedDatabaseShardingRequest request,
                                                                                                 AsyncHandler<ConfigureDistributedDatabaseShardingRequest,ConfigureDistributedDatabaseShardingResponse> handler)

Description copied from interface: DistributedDbServiceAsync

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.

Specified by:

configureDistributedDatabaseSharding in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

Creates a Globally distributed database.

Specified by:

createDistributedDatabase in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

Terminate the given Globally distributed databases.

Specified by:

deleteDistributedDatabase in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

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.

Specified by:

downloadDistributedDatabaseGsmCertificateSigningRequest in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

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.

Specified by:

generateDistributedDatabaseGsmCertificateSigningRequest in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

Generate the wallet associated with Globally distributed database.

Specified by:

generateDistributedDatabaseWallet in interface DistributedDbServiceAsync

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

public Future<GetDistributedDatabaseResponse> getDistributedDatabase(GetDistributedDatabaseRequest request,
                                                                     AsyncHandler<GetDistributedDatabaseRequest,GetDistributedDatabaseResponse> handler)

Description copied from interface: DistributedDbServiceAsync

Gets the details of the Globally distributed database identified by given id.

Specified by:

getDistributedDatabase in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

List of Globally distributed databases.

Specified by:

listDistributedDatabases in interface DistributedDbServiceAsync

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

public Future<PatchDistributedDatabaseResponse> patchDistributedDatabase(PatchDistributedDatabaseRequest request,
                                                                         AsyncHandler<PatchDistributedDatabaseRequest,PatchDistributedDatabaseResponse> handler)

Description copied from interface: DistributedDbServiceAsync

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.

Specified by:

patchDistributedDatabase in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

Rotate passwords for different components of the Globally distributed database.

Specified by:

rotateDistributedDatabasePasswords in interface DistributedDbServiceAsync

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

public Future<StartDistributedDatabaseResponse> startDistributedDatabase(StartDistributedDatabaseRequest request,
                                                                         AsyncHandler<StartDistributedDatabaseRequest,StartDistributedDatabaseResponse> handler)

Description copied from interface: DistributedDbServiceAsync

Start the shards, catalog and GSMs of Globally distributed database.

Specified by:

startDistributedDatabase in interface DistributedDbServiceAsync

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

public Future<StopDistributedDatabaseResponse> stopDistributedDatabase(StopDistributedDatabaseRequest request,
                                                                       AsyncHandler<StopDistributedDatabaseRequest,StopDistributedDatabaseResponse> handler)

Description copied from interface: DistributedDbServiceAsync

Stop the shards, catalog and GSM instances for the Globally distributed database.

Specified by:

stopDistributedDatabase in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

Updates the configuration of the Globally distributed database.

Specified by:

updateDistributedDatabase in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

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.

Specified by:

uploadDistributedDatabaseSignedCertificateAndGenerateWallet in interface DistributedDbServiceAsync

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

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

Description copied from interface: DistributedDbServiceAsync

Validate the network connectivity between components of the globally distributed database.

Specified by:

validateDistributedDatabaseNetwork in interface DistributedDbServiceAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)