Package com.oracle.bmc.distributeddatabase

Class DistributedDbServiceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.distributeddatabase.DistributedDbServiceClient

All Implemented Interfaces:

DistributedDbService, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
AddDistributedDatabaseGdsControlNodeResponse	addDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest request)	Add new Global database services control(GDS CTL) node for the Globally distributed database.
static DistributedDbServiceClient.Builder	builder()	Create a builder for this client.
ChangeDistributedDatabaseCompartmentResponse	changeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest request)	Move the Globally distributed database and its dependent resources to the specified compartment.
ChangeDistributedDbBackupConfigResponse	changeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest request)	Change the DbBackupConfig for the Globally distributed database.
void	close()
ConfigureDistributedDatabaseGsmsResponse	configureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest request)	Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.
ConfigureDistributedDatabaseShardingResponse	configureDistributedDatabaseSharding(ConfigureDistributedDatabaseShardingRequest request)	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.
CreateDistributedDatabaseResponse	createDistributedDatabase(CreateDistributedDatabaseRequest request)	Creates a Globally distributed database.
DeleteDistributedDatabaseResponse	deleteDistributedDatabase(DeleteDistributedDatabaseRequest request)	Terminate the given Globally distributed databases.
DownloadDistributedDatabaseGsmCertificateSigningRequestResponse	downloadDistributedDatabaseGsmCertificateSigningRequest(DownloadDistributedDatabaseGsmCertificateSigningRequestRequest request)	Generate the common certificate signing request for GSMs.
GenerateDistributedDatabaseGsmCertificateSigningRequestResponse	generateDistributedDatabaseGsmCertificateSigningRequest(GenerateDistributedDatabaseGsmCertificateSigningRequestRequest request)	Generate the certificate signing request for GSM instances of the Globally distributed database.
GenerateDistributedDatabaseWalletResponse	generateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest request)	Generate the wallet associated with Globally distributed database.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDistributedDatabaseResponse	getDistributedDatabase(GetDistributedDatabaseRequest request)	Gets the details of the Globally distributed database identified by given id.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
DistributedDbServicePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
DistributedDbServiceWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListDistributedDatabasesResponse	listDistributedDatabases(ListDistributedDatabasesRequest request)	List of Globally distributed databases.
PatchDistributedDatabaseResponse	patchDistributedDatabase(PatchDistributedDatabaseRequest request)	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.
RotateDistributedDatabasePasswordsResponse	rotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request)	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’).
StartDistributedDatabaseResponse	startDistributedDatabase(StartDistributedDatabaseRequest request)	Start the shards, catalog and GSMs of Globally distributed database.
StopDistributedDatabaseResponse	stopDistributedDatabase(StopDistributedDatabaseRequest request)	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.
UpdateDistributedDatabaseResponse	updateDistributedDatabase(UpdateDistributedDatabaseRequest request)	Updates the configuration of the Globally distributed database.
UploadDistributedDatabaseSignedCertificateAndGenerateWalletResponse	uploadDistributedDatabaseSignedCertificateAndGenerateWallet(UploadDistributedDatabaseSignedCertificateAndGenerateWalletRequest request)	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.
ValidateDistributedDatabaseNetworkResponse	validateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request)	Validate the network connectivity between components of the globally distributed 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.DistributedDbService

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

DistributedDbServiceClient

@Deprecated
public DistributedDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DistributedDbServiceClient

@Deprecated
public DistributedDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DistributedDbServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DistributedDbServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DistributedDbServiceClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DistributedDbServiceClient

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

DistributedDbServiceClient

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

DistributedDbServiceClient

@Deprecated
public DistributedDbServiceClient(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 DistributedDbServiceClient.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 - DistributedDbServiceClient.Builder.executorService

Method Detail

builder

public static DistributedDbServiceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DistributedDbService

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 DistributedDbService

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DistributedDbService

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 DistributedDbService

Parameters:

regionId - The public region ID.

addDistributedDatabaseGdsControlNode

public AddDistributedDatabaseGdsControlNodeResponse addDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest request)

Description copied from interface: DistributedDbService

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

Specified by:

addDistributedDatabaseGdsControlNode in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDistributedDatabaseCompartment

public ChangeDistributedDatabaseCompartmentResponse changeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest request)

Description copied from interface: DistributedDbService

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

Specified by:

changeDistributedDatabaseCompartment in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDistributedDbBackupConfig

public ChangeDistributedDbBackupConfigResponse changeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest request)

Description copied from interface: DistributedDbService

Change the DbBackupConfig for the Globally distributed database.

Specified by:

changeDistributedDbBackupConfig in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

configureDistributedDatabaseGsms

public ConfigureDistributedDatabaseGsmsResponse configureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest request)

Description copied from interface: DistributedDbService

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

Specified by:

configureDistributedDatabaseGsms in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

configureDistributedDatabaseSharding

public ConfigureDistributedDatabaseShardingResponse configureDistributedDatabaseSharding(ConfigureDistributedDatabaseShardingRequest request)

Description copied from interface: DistributedDbService

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 DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDistributedDatabase

public CreateDistributedDatabaseResponse createDistributedDatabase(CreateDistributedDatabaseRequest request)

Description copied from interface: DistributedDbService

Creates a Globally distributed database.

Specified by:

createDistributedDatabase in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDistributedDatabase

public DeleteDistributedDatabaseResponse deleteDistributedDatabase(DeleteDistributedDatabaseRequest request)

Description copied from interface: DistributedDbService

Terminate the given Globally distributed databases.

Specified by:

deleteDistributedDatabase in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

downloadDistributedDatabaseGsmCertificateSigningRequest

public DownloadDistributedDatabaseGsmCertificateSigningRequestResponse downloadDistributedDatabaseGsmCertificateSigningRequest(DownloadDistributedDatabaseGsmCertificateSigningRequestRequest request)

Description copied from interface: DistributedDbService

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 DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateDistributedDatabaseGsmCertificateSigningRequest

public GenerateDistributedDatabaseGsmCertificateSigningRequestResponse generateDistributedDatabaseGsmCertificateSigningRequest(GenerateDistributedDatabaseGsmCertificateSigningRequestRequest request)

Description copied from interface: DistributedDbService

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 DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateDistributedDatabaseWallet

public GenerateDistributedDatabaseWalletResponse generateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest request)

Description copied from interface: DistributedDbService

Generate the wallet associated with Globally distributed database.

Specified by:

generateDistributedDatabaseWallet in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDistributedDatabase

public GetDistributedDatabaseResponse getDistributedDatabase(GetDistributedDatabaseRequest request)

Description copied from interface: DistributedDbService

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

Specified by:

getDistributedDatabase in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDistributedDatabases

public ListDistributedDatabasesResponse listDistributedDatabases(ListDistributedDatabasesRequest request)

Description copied from interface: DistributedDbService

List of Globally distributed databases.

Specified by:

listDistributedDatabases in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

patchDistributedDatabase

public PatchDistributedDatabaseResponse patchDistributedDatabase(PatchDistributedDatabaseRequest request)

Description copied from interface: DistributedDbService

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 DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rotateDistributedDatabasePasswords

public RotateDistributedDatabasePasswordsResponse rotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request)

Description copied from interface: DistributedDbService

Rotate passwords for different components of the Globally distributed database.

Specified by:

rotateDistributedDatabasePasswords in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startDistributedDatabase

public StartDistributedDatabaseResponse startDistributedDatabase(StartDistributedDatabaseRequest request)

Description copied from interface: DistributedDbService

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

Specified by:

startDistributedDatabase in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopDistributedDatabase

public StopDistributedDatabaseResponse stopDistributedDatabase(StopDistributedDatabaseRequest request)

Description copied from interface: DistributedDbService

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

Specified by:

stopDistributedDatabase in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDistributedDatabase

public UpdateDistributedDatabaseResponse updateDistributedDatabase(UpdateDistributedDatabaseRequest request)

Description copied from interface: DistributedDbService

Updates the configuration of the Globally distributed database.

Specified by:

updateDistributedDatabase in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

uploadDistributedDatabaseSignedCertificateAndGenerateWallet

public UploadDistributedDatabaseSignedCertificateAndGenerateWalletResponse uploadDistributedDatabaseSignedCertificateAndGenerateWallet(UploadDistributedDatabaseSignedCertificateAndGenerateWalletRequest request)

Description copied from interface: DistributedDbService

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 DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

validateDistributedDatabaseNetwork

public ValidateDistributedDatabaseNetworkResponse validateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request)

Description copied from interface: DistributedDbService

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

Specified by:

validateDistributedDatabaseNetwork in interface DistributedDbService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DistributedDbServiceWaiters getWaiters()

Description copied from interface: DistributedDbService

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

Specified by:

getWaiters in interface DistributedDbService

Returns:

The service waiters.

getPaginators

public DistributedDbServicePaginators getPaginators()

Description copied from interface: DistributedDbService

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 DistributedDbService

Returns:

The service paginators.

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