Package com.oracle.bmc.distributeddatabase

Class DistributedAutonomousDbServiceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.distributeddatabase.DistributedAutonomousDbServiceAsyncClient

All Implemented Interfaces:

DistributedAutonomousDbServiceAsync, AutoCloseable

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

Async client implementation for DistributedAutonomousDbService 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	DistributedAutonomousDbServiceAsyncClient.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 DistributedAutonomousDbService.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Future<AddDistributedAutonomousDatabaseGdsControlNodeResponse>	addDistributedAutonomousDatabaseGdsControlNode(AddDistributedAutonomousDatabaseGdsControlNodeRequest request, AsyncHandler<AddDistributedAutonomousDatabaseGdsControlNodeRequest,AddDistributedAutonomousDatabaseGdsControlNodeResponse> handler)	Add new Global database services control(GDS CTL) node for the Globally distributed autonomous database.
static DistributedAutonomousDbServiceAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeDistributedAutonomousDatabaseCompartmentResponse>	changeDistributedAutonomousDatabaseCompartment(ChangeDistributedAutonomousDatabaseCompartmentRequest request, AsyncHandler<ChangeDistributedAutonomousDatabaseCompartmentRequest,ChangeDistributedAutonomousDatabaseCompartmentResponse> handler)	Move the Globally distributed autonomous database and its dependent resources to the specified compartment.
Future<ChangeDistributedAutonomousDbBackupConfigResponse>	changeDistributedAutonomousDbBackupConfig(ChangeDistributedAutonomousDbBackupConfigRequest request, AsyncHandler<ChangeDistributedAutonomousDbBackupConfigRequest,ChangeDistributedAutonomousDbBackupConfigResponse> handler)	Change the DbBackupConfig for the Globally distributed autonomous 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<ConfigureDistributedAutonomousDatabaseGsmsResponse>	configureDistributedAutonomousDatabaseGsms(ConfigureDistributedAutonomousDatabaseGsmsRequest request, AsyncHandler<ConfigureDistributedAutonomousDatabaseGsmsRequest,ConfigureDistributedAutonomousDatabaseGsmsResponse> handler)	Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed autonomous database.
Future<ConfigureDistributedAutonomousDatabaseShardingResponse>	configureDistributedAutonomousDatabaseSharding(ConfigureDistributedAutonomousDatabaseShardingRequest request, AsyncHandler<ConfigureDistributedAutonomousDatabaseShardingRequest,ConfigureDistributedAutonomousDatabaseShardingResponse> handler)	Once all components of Globally distributed autonomous database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the Globally distributed autonomous database.
Future<CreateDistributedAutonomousDatabaseResponse>	createDistributedAutonomousDatabase(CreateDistributedAutonomousDatabaseRequest request, AsyncHandler<CreateDistributedAutonomousDatabaseRequest,CreateDistributedAutonomousDatabaseResponse> handler)	Creates a Globally distributed autonomous database.
Future<DeleteDistributedAutonomousDatabaseResponse>	deleteDistributedAutonomousDatabase(DeleteDistributedAutonomousDatabaseRequest request, AsyncHandler<DeleteDistributedAutonomousDatabaseRequest,DeleteDistributedAutonomousDatabaseResponse> handler)	Terminate the given Globally distributed autonomous databases.
Future<DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse>	downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest(DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request, AsyncHandler<DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest,DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> handler)	Generate the common certificate signing request for GSMs.
void	enableDualStackEndpoints(boolean enableDualStackEndpoints)	This method should be used to enable or disable the use of dual-stack endpoints.
Future<GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse>	generateDistributedAutonomousDatabaseGsmCertificateSigningRequest(GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request, AsyncHandler<GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest,GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> handler)	Generate the certificate signing request for GSM instances of the Globally distributed autonomous database.
Future<GenerateDistributedAutonomousDatabaseWalletResponse>	generateDistributedAutonomousDatabaseWallet(GenerateDistributedAutonomousDatabaseWalletRequest request, AsyncHandler<GenerateDistributedAutonomousDatabaseWalletRequest,GenerateDistributedAutonomousDatabaseWalletResponse> handler)	Generate the wallet associated with Globally distributed autonomous database.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
Future<GetDistributedAutonomousDatabaseResponse>	getDistributedAutonomousDatabase(GetDistributedAutonomousDatabaseRequest request, AsyncHandler<GetDistributedAutonomousDatabaseRequest,GetDistributedAutonomousDatabaseResponse> handler)	Gets the details of the Globally distributed autonomous database identified by given id.
String	getEndpoint()	Get the endpoint of the client.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Map<String,Boolean>	getOptionsMap()	Return an immutable snapshot representing the current options set for this client.
String	getResolvedEndpoint(Map<String,Object> requiredParametersMap)	Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
Future<ListDistributedAutonomousDatabasesResponse>	listDistributedAutonomousDatabases(ListDistributedAutonomousDatabasesRequest request, AsyncHandler<ListDistributedAutonomousDatabasesRequest,ListDistributedAutonomousDatabasesResponse> handler)	List of Globally distributed autonomous databases.
Future<PatchDistributedAutonomousDatabaseResponse>	patchDistributedAutonomousDatabase(PatchDistributedAutonomousDatabaseRequest request, AsyncHandler<PatchDistributedAutonomousDatabaseRequest,PatchDistributedAutonomousDatabaseResponse> handler)	Patch operation to add, remove or update shards to the Globally distributed autonomous database topology.
void	refreshClient()	Rebuild the backing HttpClient.
Future<RotateDistributedAutonomousDatabasePasswordsResponse>	rotateDistributedAutonomousDatabasePasswords(RotateDistributedAutonomousDatabasePasswordsRequest request, AsyncHandler<RotateDistributedAutonomousDatabasePasswordsRequest,RotateDistributedAutonomousDatabasePasswordsResponse> handler)	Rotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed autonomous 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<StartDistributedAutonomousDatabaseResponse>	startDistributedAutonomousDatabase(StartDistributedAutonomousDatabaseRequest request, AsyncHandler<StartDistributedAutonomousDatabaseRequest,StartDistributedAutonomousDatabaseResponse> handler)	Start the shards, catalog and GSMs of Globally distributed autonomous database.
Future<StopDistributedAutonomousDatabaseResponse>	stopDistributedAutonomousDatabase(StopDistributedAutonomousDatabaseRequest request, AsyncHandler<StopDistributedAutonomousDatabaseRequest,StopDistributedAutonomousDatabaseResponse> handler)	Stop the shards, catalog and GSM instances for the Globally distributed autonomous database.
Future<UpdateDistributedAutonomousDatabaseResponse>	updateDistributedAutonomousDatabase(UpdateDistributedAutonomousDatabaseRequest request, AsyncHandler<UpdateDistributedAutonomousDatabaseRequest,UpdateDistributedAutonomousDatabaseResponse> handler)	Updates the configuration of the Globally distributed autonomous database.
Future<UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletResponse>	uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet(UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletRequest request, AsyncHandler<UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletRequest,UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletResponse> handler)	Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the Globally distributed autonomous database.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.
Future<ValidateDistributedAutonomousDatabaseNetworkResponse>	validateDistributedAutonomousDatabaseNetwork(ValidateDistributedAutonomousDatabaseNetworkRequest request, AsyncHandler<ValidateDistributedAutonomousDatabaseNetworkRequest,ValidateDistributedAutonomousDatabaseNetworkResponse> handler)	Validate the network connectivity between components of the globally distributed autonomous 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.DistributedAutonomousDbServiceAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DistributedAutonomousDbService.

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

DistributedAutonomousDbServiceAsyncClient

@Deprecated
public DistributedAutonomousDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DistributedAutonomousDbServiceAsyncClient

@Deprecated
public DistributedAutonomousDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                 ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DistributedAutonomousDbServiceAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DistributedAutonomousDbServiceAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DistributedAutonomousDbServiceAsyncClient

@Deprecated
public DistributedAutonomousDbServiceAsyncClient(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 DistributedAutonomousDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DistributedAutonomousDbServiceAsyncClient

@Deprecated
public DistributedAutonomousDbServiceAsyncClient(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 DistributedAutonomousDbServiceAsyncClient.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)

DistributedAutonomousDbServiceAsyncClient

@Deprecated
public DistributedAutonomousDbServiceAsyncClient(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 DistributedAutonomousDbServiceAsyncClient.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 DistributedAutonomousDbServiceAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DistributedAutonomousDbServiceAsync

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 DistributedAutonomousDbServiceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DistributedAutonomousDbServiceAsync

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 DistributedAutonomousDbServiceAsync

Parameters:

regionId - The public region ID.

addDistributedAutonomousDatabaseGdsControlNode

public Future<AddDistributedAutonomousDatabaseGdsControlNodeResponse> addDistributedAutonomousDatabaseGdsControlNode(AddDistributedAutonomousDatabaseGdsControlNodeRequest request,
                                                                                                                     AsyncHandler<AddDistributedAutonomousDatabaseGdsControlNodeRequest,AddDistributedAutonomousDatabaseGdsControlNodeResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

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

Specified by:

addDistributedAutonomousDatabaseGdsControlNode in interface DistributedAutonomousDbServiceAsync

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.

changeDistributedAutonomousDatabaseCompartment

public Future<ChangeDistributedAutonomousDatabaseCompartmentResponse> changeDistributedAutonomousDatabaseCompartment(ChangeDistributedAutonomousDatabaseCompartmentRequest request,
                                                                                                                     AsyncHandler<ChangeDistributedAutonomousDatabaseCompartmentRequest,ChangeDistributedAutonomousDatabaseCompartmentResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

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

Specified by:

changeDistributedAutonomousDatabaseCompartment in interface DistributedAutonomousDbServiceAsync

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.

changeDistributedAutonomousDbBackupConfig

public Future<ChangeDistributedAutonomousDbBackupConfigResponse> changeDistributedAutonomousDbBackupConfig(ChangeDistributedAutonomousDbBackupConfigRequest request,
                                                                                                           AsyncHandler<ChangeDistributedAutonomousDbBackupConfigRequest,ChangeDistributedAutonomousDbBackupConfigResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Change the DbBackupConfig for the Globally distributed autonomous database.

Specified by:

changeDistributedAutonomousDbBackupConfig in interface DistributedAutonomousDbServiceAsync

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.

configureDistributedAutonomousDatabaseGsms

public Future<ConfigureDistributedAutonomousDatabaseGsmsResponse> configureDistributedAutonomousDatabaseGsms(ConfigureDistributedAutonomousDatabaseGsmsRequest request,
                                                                                                             AsyncHandler<ConfigureDistributedAutonomousDatabaseGsmsRequest,ConfigureDistributedAutonomousDatabaseGsmsResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

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

Specified by:

configureDistributedAutonomousDatabaseGsms in interface DistributedAutonomousDbServiceAsync

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.

configureDistributedAutonomousDatabaseSharding

public Future<ConfigureDistributedAutonomousDatabaseShardingResponse> configureDistributedAutonomousDatabaseSharding(ConfigureDistributedAutonomousDatabaseShardingRequest request,
                                                                                                                     AsyncHandler<ConfigureDistributedAutonomousDatabaseShardingRequest,ConfigureDistributedAutonomousDatabaseShardingResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Once all components of Globally distributed autonomous database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the Globally distributed autonomous database.

Note that this ‘ConfigureSharding’ API also needs to be invoked after successfully adding a new shard to the Globally distributed autonomous 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 autonomous database.

Specified by:

configureDistributedAutonomousDatabaseSharding in interface DistributedAutonomousDbServiceAsync

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.

createDistributedAutonomousDatabase

public Future<CreateDistributedAutonomousDatabaseResponse> createDistributedAutonomousDatabase(CreateDistributedAutonomousDatabaseRequest request,
                                                                                               AsyncHandler<CreateDistributedAutonomousDatabaseRequest,CreateDistributedAutonomousDatabaseResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Creates a Globally distributed autonomous database.

Specified by:

createDistributedAutonomousDatabase in interface DistributedAutonomousDbServiceAsync

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.

deleteDistributedAutonomousDatabase

public Future<DeleteDistributedAutonomousDatabaseResponse> deleteDistributedAutonomousDatabase(DeleteDistributedAutonomousDatabaseRequest request,
                                                                                               AsyncHandler<DeleteDistributedAutonomousDatabaseRequest,DeleteDistributedAutonomousDatabaseResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Terminate the given Globally distributed autonomous databases.

Specified by:

deleteDistributedAutonomousDatabase in interface DistributedAutonomousDbServiceAsync

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.

downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest

public Future<DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest(DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request,
                                                                                                                                                           AsyncHandler<DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest,DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

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 autonomous database.

Specified by:

downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest in interface DistributedAutonomousDbServiceAsync

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.

generateDistributedAutonomousDatabaseGsmCertificateSigningRequest

public Future<GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> generateDistributedAutonomousDatabaseGsmCertificateSigningRequest(GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request,
                                                                                                                                                           AsyncHandler<GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest,GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Generate the certificate signing request for GSM instances of the Globally distributed autonomous database.

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

Specified by:

generateDistributedAutonomousDatabaseGsmCertificateSigningRequest in interface DistributedAutonomousDbServiceAsync

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.

generateDistributedAutonomousDatabaseWallet

public Future<GenerateDistributedAutonomousDatabaseWalletResponse> generateDistributedAutonomousDatabaseWallet(GenerateDistributedAutonomousDatabaseWalletRequest request,
                                                                                                               AsyncHandler<GenerateDistributedAutonomousDatabaseWalletRequest,GenerateDistributedAutonomousDatabaseWalletResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Generate the wallet associated with Globally distributed autonomous database.

Specified by:

generateDistributedAutonomousDatabaseWallet in interface DistributedAutonomousDbServiceAsync

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.

getDistributedAutonomousDatabase

public Future<GetDistributedAutonomousDatabaseResponse> getDistributedAutonomousDatabase(GetDistributedAutonomousDatabaseRequest request,
                                                                                         AsyncHandler<GetDistributedAutonomousDatabaseRequest,GetDistributedAutonomousDatabaseResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

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

Specified by:

getDistributedAutonomousDatabase in interface DistributedAutonomousDbServiceAsync

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.

listDistributedAutonomousDatabases

public Future<ListDistributedAutonomousDatabasesResponse> listDistributedAutonomousDatabases(ListDistributedAutonomousDatabasesRequest request,
                                                                                             AsyncHandler<ListDistributedAutonomousDatabasesRequest,ListDistributedAutonomousDatabasesResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

List of Globally distributed autonomous databases.

Specified by:

listDistributedAutonomousDatabases in interface DistributedAutonomousDbServiceAsync

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.

patchDistributedAutonomousDatabase

public Future<PatchDistributedAutonomousDatabaseResponse> patchDistributedAutonomousDatabase(PatchDistributedAutonomousDatabaseRequest request,
                                                                                             AsyncHandler<PatchDistributedAutonomousDatabaseRequest,PatchDistributedAutonomousDatabaseResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Patch operation to add, remove or update shards to the Globally distributed autonomous 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:

patchDistributedAutonomousDatabase in interface DistributedAutonomousDbServiceAsync

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.

rotateDistributedAutonomousDatabasePasswords

public Future<RotateDistributedAutonomousDatabasePasswordsResponse> rotateDistributedAutonomousDatabasePasswords(RotateDistributedAutonomousDatabasePasswordsRequest request,
                                                                                                                 AsyncHandler<RotateDistributedAutonomousDatabasePasswordsRequest,RotateDistributedAutonomousDatabasePasswordsResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Rotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed autonomous database.

This operation will also remove GdsCtlNodes if present.

Specified by:

rotateDistributedAutonomousDatabasePasswords in interface DistributedAutonomousDbServiceAsync

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.

startDistributedAutonomousDatabase

public Future<StartDistributedAutonomousDatabaseResponse> startDistributedAutonomousDatabase(StartDistributedAutonomousDatabaseRequest request,
                                                                                             AsyncHandler<StartDistributedAutonomousDatabaseRequest,StartDistributedAutonomousDatabaseResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

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

Specified by:

startDistributedAutonomousDatabase in interface DistributedAutonomousDbServiceAsync

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.

stopDistributedAutonomousDatabase

public Future<StopDistributedAutonomousDatabaseResponse> stopDistributedAutonomousDatabase(StopDistributedAutonomousDatabaseRequest request,
                                                                                           AsyncHandler<StopDistributedAutonomousDatabaseRequest,StopDistributedAutonomousDatabaseResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

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

Specified by:

stopDistributedAutonomousDatabase in interface DistributedAutonomousDbServiceAsync

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.

updateDistributedAutonomousDatabase

public Future<UpdateDistributedAutonomousDatabaseResponse> updateDistributedAutonomousDatabase(UpdateDistributedAutonomousDatabaseRequest request,
                                                                                               AsyncHandler<UpdateDistributedAutonomousDatabaseRequest,UpdateDistributedAutonomousDatabaseResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Updates the configuration of the Globally distributed autonomous database.

Specified by:

updateDistributedAutonomousDatabase in interface DistributedAutonomousDbServiceAsync

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.

uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet

public Future<UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletResponse> uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet(UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletRequest request,
                                                                                                                                                                   AsyncHandler<UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletRequest,UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the Globally distributed autonomous database.

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

Specified by:

uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet in interface DistributedAutonomousDbServiceAsync

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.

validateDistributedAutonomousDatabaseNetwork

public Future<ValidateDistributedAutonomousDatabaseNetworkResponse> validateDistributedAutonomousDatabaseNetwork(ValidateDistributedAutonomousDatabaseNetworkRequest request,
                                                                                                                 AsyncHandler<ValidateDistributedAutonomousDatabaseNetworkRequest,ValidateDistributedAutonomousDatabaseNetworkResponse> handler)

Description copied from interface: DistributedAutonomousDbServiceAsync

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

Specified by:

validateDistributedAutonomousDatabaseNetwork in interface DistributedAutonomousDbServiceAsync

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()

enableDualStackEndpoints

public void enableDualStackEndpoints(boolean enableDualStackEndpoints)

This method should be used to enable or disable the use of dual-stack endpoints.

The default value is false i.e. dual-stack endpoints are disabled by default.

Parameters:

enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively

getOptionsMap

public Map<String,Boolean> getOptionsMap()

Return an immutable snapshot representing the current options set for this client.

Returns:

immutable snapshot representing the current options set for this client

getResolvedEndpoint

public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)

Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.

Parameters:

requiredParametersMap - the map from required parameter name to their values

Returns:

resolved endpoint, with all options and placeholders filled in

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

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

Get the endpoint of the client.

Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.

Examples of endpoints this may return:

• Unparameterized endpoints

               https://identity.us-phoenix-1.oci.oraclecloud.com
               https://identity.us-ashburn-1.oci.oraclecloud.com
               https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
           

• Parameterized endpoints with placeholders

               https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com
               https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
           

• Parameterized endpoints with options

               https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com
               https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
           

• Parameterized endpoints with placeholders and options

               https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com
               https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
           

To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

Returns:

the endpoint being used by the client

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)