Package com.oracle.bmc.distributeddatabase

Class DistributedAutonomousDbServiceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.distributeddatabase.DistributedAutonomousDbServiceClient

All Implemented Interfaces:

DistributedAutonomousDbService, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20250101")
public class DistributedAutonomousDbServiceClient
extends BaseSyncClient
implements DistributedAutonomousDbService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistributedAutonomousDbServiceClient.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
DistributedAutonomousDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
DistributedAutonomousDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
DistributedAutonomousDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DistributedAutonomousDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DistributedAutonomousDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
DistributedAutonomousDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
DistributedAutonomousDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
DistributedAutonomousDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
AddDistributedAutonomousDatabaseGdsControlNodeResponse	addDistributedAutonomousDatabaseGdsControlNode(AddDistributedAutonomousDatabaseGdsControlNodeRequest request)	Add new Global database services control(GDS CTL) node for the Globally distributed autonomous database.
static DistributedAutonomousDbServiceClient.Builder	builder()	Create a builder for this client.
ChangeDistributedAutonomousDatabaseCompartmentResponse	changeDistributedAutonomousDatabaseCompartment(ChangeDistributedAutonomousDatabaseCompartmentRequest request)	Move the Globally distributed autonomous database and its dependent resources to the specified compartment.
ChangeDistributedAutonomousDbBackupConfigResponse	changeDistributedAutonomousDbBackupConfig(ChangeDistributedAutonomousDbBackupConfigRequest request)	Change the DbBackupConfig for the Globally distributed autonomous database.
void	close()
ConfigureDistributedAutonomousDatabaseGsmsResponse	configureDistributedAutonomousDatabaseGsms(ConfigureDistributedAutonomousDatabaseGsmsRequest request)	Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed autonomous database.
ConfigureDistributedAutonomousDatabaseShardingResponse	configureDistributedAutonomousDatabaseSharding(ConfigureDistributedAutonomousDatabaseShardingRequest request)	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.
CreateDistributedAutonomousDatabaseResponse	createDistributedAutonomousDatabase(CreateDistributedAutonomousDatabaseRequest request)	Creates a Globally distributed autonomous database.
DeleteDistributedAutonomousDatabaseResponse	deleteDistributedAutonomousDatabase(DeleteDistributedAutonomousDatabaseRequest request)	Terminate the given Globally distributed autonomous databases.
DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse	downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest(DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request)	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.
GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse	generateDistributedAutonomousDatabaseGsmCertificateSigningRequest(GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request)	Generate the certificate signing request for GSM instances of the Globally distributed autonomous database.
GenerateDistributedAutonomousDatabaseWalletResponse	generateDistributedAutonomousDatabaseWallet(GenerateDistributedAutonomousDatabaseWalletRequest request)	Generate the wallet associated with Globally distributed autonomous database.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDistributedAutonomousDatabaseResponse	getDistributedAutonomousDatabase(GetDistributedAutonomousDatabaseRequest request)	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.
DistributedAutonomousDbServicePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
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.
DistributedAutonomousDbServiceWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListDistributedAutonomousDatabasesResponse	listDistributedAutonomousDatabases(ListDistributedAutonomousDatabasesRequest request)	List of Globally distributed autonomous databases.
PatchDistributedAutonomousDatabaseResponse	patchDistributedAutonomousDatabase(PatchDistributedAutonomousDatabaseRequest request)	Patch operation to add, remove or update shards to the Globally distributed autonomous database topology.
void	refreshClient()	Rebuild the backing HttpClient.
RotateDistributedAutonomousDatabasePasswordsResponse	rotateDistributedAutonomousDatabasePasswords(RotateDistributedAutonomousDatabasePasswordsRequest request)	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’).
StartDistributedAutonomousDatabaseResponse	startDistributedAutonomousDatabase(StartDistributedAutonomousDatabaseRequest request)	Start the shards, catalog and GSMs of Globally distributed autonomous database.
StopDistributedAutonomousDatabaseResponse	stopDistributedAutonomousDatabase(StopDistributedAutonomousDatabaseRequest request)	Stop the shards, catalog and GSM instances for the Globally distributed autonomous database.
UpdateDistributedAutonomousDatabaseResponse	updateDistributedAutonomousDatabase(UpdateDistributedAutonomousDatabaseRequest request)	Updates the configuration of the Globally distributed autonomous database.
UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletResponse	uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet(UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletRequest request)	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.
ValidateDistributedAutonomousDatabaseNetworkResponse	validateDistributedAutonomousDatabaseNetwork(ValidateDistributedAutonomousDatabaseNetworkRequest request)	Validate the network connectivity between components of the globally distributed autonomous database.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

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

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

DistributedAutonomousDbServiceClient

@Deprecated
public DistributedAutonomousDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DistributedAutonomousDbServiceClient

@Deprecated
public DistributedAutonomousDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DistributedAutonomousDbServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DistributedAutonomousDbServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DistributedAutonomousDbServiceClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DistributedAutonomousDbServiceClient

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

DistributedAutonomousDbServiceClient

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

DistributedAutonomousDbServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DistributedAutonomousDbServiceClient.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

executorService - DistributedAutonomousDbServiceClient.Builder.executorService

Method Detail

builder

public static DistributedAutonomousDbServiceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DistributedAutonomousDbService

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 DistributedAutonomousDbService

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DistributedAutonomousDbService

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 DistributedAutonomousDbService

Parameters:

regionId - The public region ID.

addDistributedAutonomousDatabaseGdsControlNode

public AddDistributedAutonomousDatabaseGdsControlNodeResponse addDistributedAutonomousDatabaseGdsControlNode(AddDistributedAutonomousDatabaseGdsControlNodeRequest request)

Description copied from interface: DistributedAutonomousDbService

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

Specified by:

addDistributedAutonomousDatabaseGdsControlNode in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDistributedAutonomousDatabaseCompartment

public ChangeDistributedAutonomousDatabaseCompartmentResponse changeDistributedAutonomousDatabaseCompartment(ChangeDistributedAutonomousDatabaseCompartmentRequest request)

Description copied from interface: DistributedAutonomousDbService

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

Specified by:

changeDistributedAutonomousDatabaseCompartment in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDistributedAutonomousDbBackupConfig

public ChangeDistributedAutonomousDbBackupConfigResponse changeDistributedAutonomousDbBackupConfig(ChangeDistributedAutonomousDbBackupConfigRequest request)

Description copied from interface: DistributedAutonomousDbService

Change the DbBackupConfig for the Globally distributed autonomous database.

Specified by:

changeDistributedAutonomousDbBackupConfig in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

configureDistributedAutonomousDatabaseGsms

public ConfigureDistributedAutonomousDatabaseGsmsResponse configureDistributedAutonomousDatabaseGsms(ConfigureDistributedAutonomousDatabaseGsmsRequest request)

Description copied from interface: DistributedAutonomousDbService

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

Specified by:

configureDistributedAutonomousDatabaseGsms in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

configureDistributedAutonomousDatabaseSharding

public ConfigureDistributedAutonomousDatabaseShardingResponse configureDistributedAutonomousDatabaseSharding(ConfigureDistributedAutonomousDatabaseShardingRequest request)

Description copied from interface: DistributedAutonomousDbService

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 DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDistributedAutonomousDatabase

public CreateDistributedAutonomousDatabaseResponse createDistributedAutonomousDatabase(CreateDistributedAutonomousDatabaseRequest request)

Description copied from interface: DistributedAutonomousDbService

Creates a Globally distributed autonomous database.

Specified by:

createDistributedAutonomousDatabase in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDistributedAutonomousDatabase

public DeleteDistributedAutonomousDatabaseResponse deleteDistributedAutonomousDatabase(DeleteDistributedAutonomousDatabaseRequest request)

Description copied from interface: DistributedAutonomousDbService

Terminate the given Globally distributed autonomous databases.

Specified by:

deleteDistributedAutonomousDatabase in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest

public DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest(DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request)

Description copied from interface: DistributedAutonomousDbService

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 DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateDistributedAutonomousDatabaseGsmCertificateSigningRequest

public GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse generateDistributedAutonomousDatabaseGsmCertificateSigningRequest(GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request)

Description copied from interface: DistributedAutonomousDbService

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 DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateDistributedAutonomousDatabaseWallet

public GenerateDistributedAutonomousDatabaseWalletResponse generateDistributedAutonomousDatabaseWallet(GenerateDistributedAutonomousDatabaseWalletRequest request)

Description copied from interface: DistributedAutonomousDbService

Generate the wallet associated with Globally distributed autonomous database.

Specified by:

generateDistributedAutonomousDatabaseWallet in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDistributedAutonomousDatabase

public GetDistributedAutonomousDatabaseResponse getDistributedAutonomousDatabase(GetDistributedAutonomousDatabaseRequest request)

Description copied from interface: DistributedAutonomousDbService

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

Specified by:

getDistributedAutonomousDatabase in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDistributedAutonomousDatabases

public ListDistributedAutonomousDatabasesResponse listDistributedAutonomousDatabases(ListDistributedAutonomousDatabasesRequest request)

Description copied from interface: DistributedAutonomousDbService

List of Globally distributed autonomous databases.

Specified by:

listDistributedAutonomousDatabases in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

patchDistributedAutonomousDatabase

public PatchDistributedAutonomousDatabaseResponse patchDistributedAutonomousDatabase(PatchDistributedAutonomousDatabaseRequest request)

Description copied from interface: DistributedAutonomousDbService

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 DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rotateDistributedAutonomousDatabasePasswords

public RotateDistributedAutonomousDatabasePasswordsResponse rotateDistributedAutonomousDatabasePasswords(RotateDistributedAutonomousDatabasePasswordsRequest request)

Description copied from interface: DistributedAutonomousDbService

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 DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startDistributedAutonomousDatabase

public StartDistributedAutonomousDatabaseResponse startDistributedAutonomousDatabase(StartDistributedAutonomousDatabaseRequest request)

Description copied from interface: DistributedAutonomousDbService

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

Specified by:

startDistributedAutonomousDatabase in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopDistributedAutonomousDatabase

public StopDistributedAutonomousDatabaseResponse stopDistributedAutonomousDatabase(StopDistributedAutonomousDatabaseRequest request)

Description copied from interface: DistributedAutonomousDbService

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

Specified by:

stopDistributedAutonomousDatabase in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDistributedAutonomousDatabase

public UpdateDistributedAutonomousDatabaseResponse updateDistributedAutonomousDatabase(UpdateDistributedAutonomousDatabaseRequest request)

Description copied from interface: DistributedAutonomousDbService

Updates the configuration of the Globally distributed autonomous database.

Specified by:

updateDistributedAutonomousDatabase in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet

public UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletResponse uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet(UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletRequest request)

Description copied from interface: DistributedAutonomousDbService

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 DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

validateDistributedAutonomousDatabaseNetwork

public ValidateDistributedAutonomousDatabaseNetworkResponse validateDistributedAutonomousDatabaseNetwork(ValidateDistributedAutonomousDatabaseNetworkRequest request)

Description copied from interface: DistributedAutonomousDbService

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

Specified by:

validateDistributedAutonomousDatabaseNetwork in interface DistributedAutonomousDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DistributedAutonomousDbServiceWaiters getWaiters()

Description copied from interface: DistributedAutonomousDbService

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface DistributedAutonomousDbService

Returns:

The service waiters.

getPaginators

public DistributedAutonomousDbServicePaginators getPaginators()

Description copied from interface: DistributedAutonomousDbService

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface DistributedAutonomousDbService

Returns:

The service paginators.

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