Package com.oracle.bmc.globallydistributeddatabase

Class ShardedDatabaseServiceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.globallydistributeddatabase.ShardedDatabaseServiceAsyncClient

All Implemented Interfaces:

ShardedDatabaseServiceAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230301")
public class ShardedDatabaseServiceAsyncClient
extends BaseAsyncClient
implements ShardedDatabaseServiceAsync

Async client implementation for ShardedDatabaseService 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	ShardedDatabaseServiceAsyncClient.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 ShardedDatabaseService.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ShardedDatabaseServiceAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangePrivateEndpointCompartmentResponse>	changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request, AsyncHandler<ChangePrivateEndpointCompartmentRequest,ChangePrivateEndpointCompartmentResponse> handler)	Move the private endpoint to the specified compartment.
Future<ChangeShardedDatabaseCompartmentResponse>	changeShardedDatabaseCompartment(ChangeShardedDatabaseCompartmentRequest request, AsyncHandler<ChangeShardedDatabaseCompartmentRequest,ChangeShardedDatabaseCompartmentResponse> handler)	Move the sharded database database and its dependent resources to the specified compartment.
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<ConfigureShardedDatabaseGsmsResponse>	configureShardedDatabaseGsms(ConfigureShardedDatabaseGsmsRequest request, AsyncHandler<ConfigureShardedDatabaseGsmsRequest,ConfigureShardedDatabaseGsmsResponse> handler)	Configure new Global Service Manager(GSM aka shard manager) instances for the sharded database.
Future<ConfigureShardingResponse>	configureSharding(ConfigureShardingRequest request, AsyncHandler<ConfigureShardingRequest,ConfigureShardingResponse> handler)	Once all components of sharded database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the sharded database.
Future<CreatePrivateEndpointResponse>	createPrivateEndpoint(CreatePrivateEndpointRequest request, AsyncHandler<CreatePrivateEndpointRequest,CreatePrivateEndpointResponse> handler)	Creates a PrivateEndpoint.
Future<CreateShardedDatabaseResponse>	createShardedDatabase(CreateShardedDatabaseRequest request, AsyncHandler<CreateShardedDatabaseRequest,CreateShardedDatabaseResponse> handler)	Creates a Sharded Database.
Future<DeletePrivateEndpointResponse>	deletePrivateEndpoint(DeletePrivateEndpointRequest request, AsyncHandler<DeletePrivateEndpointRequest,DeletePrivateEndpointResponse> handler)	Delete the given private endpoint.
Future<DeleteShardedDatabaseResponse>	deleteShardedDatabase(DeleteShardedDatabaseRequest request, AsyncHandler<DeleteShardedDatabaseRequest,DeleteShardedDatabaseResponse> handler)	Terminate the given sharded databases.
Future<DownloadGsmCertificateSigningRequestResponse>	downloadGsmCertificateSigningRequest(DownloadGsmCertificateSigningRequestRequest request, AsyncHandler<DownloadGsmCertificateSigningRequestRequest,DownloadGsmCertificateSigningRequestResponse> handler)	Generate the common certificate signing request for GSMs.
Future<FetchConnectionStringResponse>	fetchConnectionString(FetchConnectionStringRequest request, AsyncHandler<FetchConnectionStringRequest,FetchConnectionStringResponse> handler)	Gets the Sharded Database Connection Strings.
Future<FetchShardableCloudAutonomousVmClustersResponse>	fetchShardableCloudAutonomousVmClusters(FetchShardableCloudAutonomousVmClustersRequest request, AsyncHandler<FetchShardableCloudAutonomousVmClustersRequest,FetchShardableCloudAutonomousVmClustersResponse> handler)	List of cloudAutonomousVMClusters for the given tenancy, that can be sharded.
Future<GenerateGsmCertificateSigningRequestResponse>	generateGsmCertificateSigningRequest(GenerateGsmCertificateSigningRequestRequest request, AsyncHandler<GenerateGsmCertificateSigningRequestRequest,GenerateGsmCertificateSigningRequestResponse> handler)	Generate the certificate signing request for GSM instances of the sharded database.
Future<GenerateWalletResponse>	generateWallet(GenerateWalletRequest request, AsyncHandler<GenerateWalletRequest,GenerateWalletResponse> handler)	Generate the wallet associated with sharded database.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetPrivateEndpointResponse>	getPrivateEndpoint(GetPrivateEndpointRequest request, AsyncHandler<GetPrivateEndpointRequest,GetPrivateEndpointResponse> handler)	Get the PrivateEndpoint resource.
Future<GetShardedDatabaseResponse>	getShardedDatabase(GetShardedDatabaseRequest request, AsyncHandler<GetShardedDatabaseRequest,GetShardedDatabaseResponse> handler)	Gets the details of the Sharded database identified by given id.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)	Gets details of the work request with the given ID.
Future<ListPrivateEndpointsResponse>	listPrivateEndpoints(ListPrivateEndpointsRequest request, AsyncHandler<ListPrivateEndpointsRequest,ListPrivateEndpointsResponse> handler)	List of PrivateEndpoints.
Future<ListShardedDatabasesResponse>	listShardedDatabases(ListShardedDatabasesRequest request, AsyncHandler<ListShardedDatabasesRequest,ListShardedDatabasesResponse> handler)	List of Sharded databases.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)	Returns a (paginated) list of errors for the work request with the given ID.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)	Returns a (paginated) list of logs for the work request with the given ID.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)	Lists the work requests in a compartment.
Future<PatchShardedDatabaseResponse>	patchShardedDatabase(PatchShardedDatabaseRequest request, AsyncHandler<PatchShardedDatabaseRequest,PatchShardedDatabaseResponse> handler)	Patch operation to add, remove or update shards to the sharded 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.
Future<PrevalidateShardedDatabaseResponse>	prevalidateShardedDatabase(PrevalidateShardedDatabaseRequest request, AsyncHandler<PrevalidateShardedDatabaseRequest,PrevalidateShardedDatabaseResponse> handler)	Sharded database pre-validation request.
void	refreshClient()	Rebuild the backing HttpClient.
Future<ReinstateProxyInstanceResponse>	reinstateProxyInstance(ReinstateProxyInstanceRequest request, AsyncHandler<ReinstateProxyInstanceRequest,ReinstateProxyInstanceResponse> handler)	API to reinstate the proxy instances associated with the private endpoint.
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<StartShardedDatabaseResponse>	startShardedDatabase(StartShardedDatabaseRequest request, AsyncHandler<StartShardedDatabaseRequest,StartShardedDatabaseResponse> handler)	Start the shards, catalog and GSMs of Sharded Database.
Future<StopShardedDatabaseResponse>	stopShardedDatabase(StopShardedDatabaseRequest request, AsyncHandler<StopShardedDatabaseRequest,StopShardedDatabaseResponse> handler)	Stop the shards, catalog and GSM instances for the sharded database.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdatePrivateEndpointResponse>	updatePrivateEndpoint(UpdatePrivateEndpointRequest request, AsyncHandler<UpdatePrivateEndpointRequest,UpdatePrivateEndpointResponse> handler)	Updates the configuration of privateendpoint.
Future<UpdateShardedDatabaseResponse>	updateShardedDatabase(UpdateShardedDatabaseRequest request, AsyncHandler<UpdateShardedDatabaseRequest,UpdateShardedDatabaseResponse> handler)	Updates the configuration of sharded database.
Future<UploadSignedCertificateAndGenerateWalletResponse>	uploadSignedCertificateAndGenerateWallet(UploadSignedCertificateAndGenerateWalletRequest request, AsyncHandler<UploadSignedCertificateAndGenerateWalletRequest,UploadSignedCertificateAndGenerateWalletResponse> handler)	Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the sharded database.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.
Future<ValidateNetworkResponse>	validateNetwork(ValidateNetworkRequest request, AsyncHandler<ValidateNetworkRequest,ValidateNetworkResponse> handler)	Validate the network connectivity between components of sharded 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.globallydistributeddatabase.ShardedDatabaseServiceAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ShardedDatabaseService.

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

ShardedDatabaseServiceAsyncClient

@Deprecated
public ShardedDatabaseServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

ShardedDatabaseServiceAsyncClient

@Deprecated
public ShardedDatabaseServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ShardedDatabaseServiceAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ShardedDatabaseServiceAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ShardedDatabaseServiceAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ShardedDatabaseServiceAsyncClient

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

ShardedDatabaseServiceAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ShardedDatabaseServiceAsync

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 ShardedDatabaseServiceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ShardedDatabaseServiceAsync

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 ShardedDatabaseServiceAsync

Parameters:

regionId - The public region ID.

changePrivateEndpointCompartment

public Future<ChangePrivateEndpointCompartmentResponse> changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request,
                                                                                         AsyncHandler<ChangePrivateEndpointCompartmentRequest,ChangePrivateEndpointCompartmentResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Move the private endpoint to the specified compartment.

Specified by:

changePrivateEndpointCompartment in interface ShardedDatabaseServiceAsync

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.

changeShardedDatabaseCompartment

public Future<ChangeShardedDatabaseCompartmentResponse> changeShardedDatabaseCompartment(ChangeShardedDatabaseCompartmentRequest request,
                                                                                         AsyncHandler<ChangeShardedDatabaseCompartmentRequest,ChangeShardedDatabaseCompartmentResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Move the sharded database database and its dependent resources to the specified compartment.

Specified by:

changeShardedDatabaseCompartment in interface ShardedDatabaseServiceAsync

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.

configureShardedDatabaseGsms

public Future<ConfigureShardedDatabaseGsmsResponse> configureShardedDatabaseGsms(ConfigureShardedDatabaseGsmsRequest request,
                                                                                 AsyncHandler<ConfigureShardedDatabaseGsmsRequest,ConfigureShardedDatabaseGsmsResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

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

Specify the names of old GSM instances that need to be replaced via parameter oldGsmNames in the request payload. Also specify whether rotated GSM instances shall be provisioned with latest image of GSM software or the image used by existing GSM instances shall be used.

Specified by:

configureShardedDatabaseGsms in interface ShardedDatabaseServiceAsync

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.

configureSharding

public Future<ConfigureShardingResponse> configureSharding(ConfigureShardingRequest request,
                                                           AsyncHandler<ConfigureShardingRequest,ConfigureShardingResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

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

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

Specified by:

configureSharding in interface ShardedDatabaseServiceAsync

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.

createPrivateEndpoint

public Future<CreatePrivateEndpointResponse> createPrivateEndpoint(CreatePrivateEndpointRequest request,
                                                                   AsyncHandler<CreatePrivateEndpointRequest,CreatePrivateEndpointResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Creates a PrivateEndpoint.

Specified by:

createPrivateEndpoint in interface ShardedDatabaseServiceAsync

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.

createShardedDatabase

public Future<CreateShardedDatabaseResponse> createShardedDatabase(CreateShardedDatabaseRequest request,
                                                                   AsyncHandler<CreateShardedDatabaseRequest,CreateShardedDatabaseResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Creates a Sharded Database.

Specified by:

createShardedDatabase in interface ShardedDatabaseServiceAsync

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.

deletePrivateEndpoint

public Future<DeletePrivateEndpointResponse> deletePrivateEndpoint(DeletePrivateEndpointRequest request,
                                                                   AsyncHandler<DeletePrivateEndpointRequest,DeletePrivateEndpointResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Delete the given private endpoint.

Specified by:

deletePrivateEndpoint in interface ShardedDatabaseServiceAsync

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.

deleteShardedDatabase

public Future<DeleteShardedDatabaseResponse> deleteShardedDatabase(DeleteShardedDatabaseRequest request,
                                                                   AsyncHandler<DeleteShardedDatabaseRequest,DeleteShardedDatabaseResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Terminate the given sharded databases.

Specified by:

deleteShardedDatabase in interface ShardedDatabaseServiceAsync

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.

downloadGsmCertificateSigningRequest

public Future<DownloadGsmCertificateSigningRequestResponse> downloadGsmCertificateSigningRequest(DownloadGsmCertificateSigningRequestRequest request,
                                                                                                 AsyncHandler<DownloadGsmCertificateSigningRequestRequest,DownloadGsmCertificateSigningRequestResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

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

Specified by:

downloadGsmCertificateSigningRequest in interface ShardedDatabaseServiceAsync

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.

fetchConnectionString

public Future<FetchConnectionStringResponse> fetchConnectionString(FetchConnectionStringRequest request,
                                                                   AsyncHandler<FetchConnectionStringRequest,FetchConnectionStringResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Gets the Sharded Database Connection Strings.

Specified by:

fetchConnectionString in interface ShardedDatabaseServiceAsync

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.

fetchShardableCloudAutonomousVmClusters

public Future<FetchShardableCloudAutonomousVmClustersResponse> fetchShardableCloudAutonomousVmClusters(FetchShardableCloudAutonomousVmClustersRequest request,
                                                                                                       AsyncHandler<FetchShardableCloudAutonomousVmClustersRequest,FetchShardableCloudAutonomousVmClustersResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

List of cloudAutonomousVMClusters for the given tenancy, that can be sharded.

Specified by:

fetchShardableCloudAutonomousVmClusters in interface ShardedDatabaseServiceAsync

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.

generateGsmCertificateSigningRequest

public Future<GenerateGsmCertificateSigningRequestResponse> generateGsmCertificateSigningRequest(GenerateGsmCertificateSigningRequestRequest request,
                                                                                                 AsyncHandler<GenerateGsmCertificateSigningRequestRequest,GenerateGsmCertificateSigningRequestResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Generate the certificate signing request for GSM instances of the sharded database.

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

Specified by:

generateGsmCertificateSigningRequest in interface ShardedDatabaseServiceAsync

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.

generateWallet

public Future<GenerateWalletResponse> generateWallet(GenerateWalletRequest request,
                                                     AsyncHandler<GenerateWalletRequest,GenerateWalletResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Generate the wallet associated with sharded database.

Specified by:

generateWallet in interface ShardedDatabaseServiceAsync

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.

getPrivateEndpoint

public Future<GetPrivateEndpointResponse> getPrivateEndpoint(GetPrivateEndpointRequest request,
                                                             AsyncHandler<GetPrivateEndpointRequest,GetPrivateEndpointResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Get the PrivateEndpoint resource.

Specified by:

getPrivateEndpoint in interface ShardedDatabaseServiceAsync

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.

getShardedDatabase

public Future<GetShardedDatabaseResponse> getShardedDatabase(GetShardedDatabaseRequest request,
                                                             AsyncHandler<GetShardedDatabaseRequest,GetShardedDatabaseResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Gets the details of the Sharded database identified by given id.

Specified by:

getShardedDatabase in interface ShardedDatabaseServiceAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Gets details of the work request with the given ID.

Specified by:

getWorkRequest in interface ShardedDatabaseServiceAsync

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.

listPrivateEndpoints

public Future<ListPrivateEndpointsResponse> listPrivateEndpoints(ListPrivateEndpointsRequest request,
                                                                 AsyncHandler<ListPrivateEndpointsRequest,ListPrivateEndpointsResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

List of PrivateEndpoints.

Specified by:

listPrivateEndpoints in interface ShardedDatabaseServiceAsync

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.

listShardedDatabases

public Future<ListShardedDatabasesResponse> listShardedDatabases(ListShardedDatabasesRequest request,
                                                                 AsyncHandler<ListShardedDatabasesRequest,ListShardedDatabasesResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

List of Sharded databases.

Specified by:

listShardedDatabases in interface ShardedDatabaseServiceAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Returns a (paginated) list of errors for the work request with the given ID.

Specified by:

listWorkRequestErrors in interface ShardedDatabaseServiceAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Returns a (paginated) list of logs for the work request with the given ID.

Specified by:

listWorkRequestLogs in interface ShardedDatabaseServiceAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ShardedDatabaseServiceAsync

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.

patchShardedDatabase

public Future<PatchShardedDatabaseResponse> patchShardedDatabase(PatchShardedDatabaseRequest request,
                                                                 AsyncHandler<PatchShardedDatabaseRequest,PatchShardedDatabaseResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

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

patchShardedDatabase in interface ShardedDatabaseServiceAsync

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.

prevalidateShardedDatabase

public Future<PrevalidateShardedDatabaseResponse> prevalidateShardedDatabase(PrevalidateShardedDatabaseRequest request,
                                                                             AsyncHandler<PrevalidateShardedDatabaseRequest,PrevalidateShardedDatabaseResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Sharded database pre-validation request.

Specified by:

prevalidateShardedDatabase in interface ShardedDatabaseServiceAsync

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.

reinstateProxyInstance

public Future<ReinstateProxyInstanceResponse> reinstateProxyInstance(ReinstateProxyInstanceRequest request,
                                                                     AsyncHandler<ReinstateProxyInstanceRequest,ReinstateProxyInstanceResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

API to reinstate the proxy instances associated with the private endpoint.

Specified by:

reinstateProxyInstance in interface ShardedDatabaseServiceAsync

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.

startShardedDatabase

public Future<StartShardedDatabaseResponse> startShardedDatabase(StartShardedDatabaseRequest request,
                                                                 AsyncHandler<StartShardedDatabaseRequest,StartShardedDatabaseResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Start the shards, catalog and GSMs of Sharded Database.

Specified by:

startShardedDatabase in interface ShardedDatabaseServiceAsync

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.

stopShardedDatabase

public Future<StopShardedDatabaseResponse> stopShardedDatabase(StopShardedDatabaseRequest request,
                                                               AsyncHandler<StopShardedDatabaseRequest,StopShardedDatabaseResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Stop the shards, catalog and GSM instances for the sharded database.

Specified by:

stopShardedDatabase in interface ShardedDatabaseServiceAsync

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.

updatePrivateEndpoint

public Future<UpdatePrivateEndpointResponse> updatePrivateEndpoint(UpdatePrivateEndpointRequest request,
                                                                   AsyncHandler<UpdatePrivateEndpointRequest,UpdatePrivateEndpointResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Updates the configuration of privateendpoint.

Specified by:

updatePrivateEndpoint in interface ShardedDatabaseServiceAsync

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.

updateShardedDatabase

public Future<UpdateShardedDatabaseResponse> updateShardedDatabase(UpdateShardedDatabaseRequest request,
                                                                   AsyncHandler<UpdateShardedDatabaseRequest,UpdateShardedDatabaseResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Updates the configuration of sharded database.

Specified by:

updateShardedDatabase in interface ShardedDatabaseServiceAsync

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.

uploadSignedCertificateAndGenerateWallet

public Future<UploadSignedCertificateAndGenerateWalletResponse> uploadSignedCertificateAndGenerateWallet(UploadSignedCertificateAndGenerateWalletRequest request,
                                                                                                         AsyncHandler<UploadSignedCertificateAndGenerateWalletRequest,UploadSignedCertificateAndGenerateWalletResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the sharded database.

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

Specified by:

uploadSignedCertificateAndGenerateWallet in interface ShardedDatabaseServiceAsync

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.

validateNetwork

public Future<ValidateNetworkResponse> validateNetwork(ValidateNetworkRequest request,
                                                       AsyncHandler<ValidateNetworkRequest,ValidateNetworkResponse> handler)

Description copied from interface: ShardedDatabaseServiceAsync

Validate the network connectivity between components of sharded database.

Specified by:

validateNetwork in interface ShardedDatabaseServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

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

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

Parameters:

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

populateServiceParametersInEndpoint

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

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

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

Parameters:

endpoint - The endpoint template in use

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

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

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

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

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

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

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