Class DistributedDbServiceAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.distributeddatabasev26.DistributedDbServiceAsyncClient
-
- All Implemented Interfaces:
DistributedDbServiceAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20260101") public class DistributedDbServiceAsyncClient extends BaseAsyncClient implements DistributedDbServiceAsyncAsync client implementation for DistributedDbService service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, 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 classDistributedDbServiceAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for DistributedDbService.
-
Constructor Summary
Constructors Constructor Description DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.distributeddatabasev26.DistributedDbServiceAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DistributedDbServiceAsyncClient
@Deprecated public DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DistributedDbServiceAsyncClient
@Deprecated public DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DistributedDbServiceAsyncClient
@Deprecated public DistributedDbServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DistributedDbServiceAsyncClient
@Deprecated public DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DistributedDbServiceAsyncClient
@Deprecated public DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DistributedDbServiceAsyncClient
@Deprecated public DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
DistributedDbServiceAsyncClient
@Deprecated public DistributedDbServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static DistributedDbServiceAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DistributedDbServiceAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceDistributedDbServiceAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DistributedDbServiceAsyncSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceDistributedDbServiceAsync- Parameters:
regionId- The public region ID.
-
addDistributedDatabaseGdsControlNode
public Future<AddDistributedDatabaseGdsControlNodeResponse> addDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest request, AsyncHandler<AddDistributedDatabaseGdsControlNodeRequest,AddDistributedDatabaseGdsControlNodeResponse> handler)
Description copied from interface:DistributedDbServiceAsyncAdd new Global database services control(GDS CTL) node for the Globally distributed database.- Specified by:
addDistributedDatabaseGdsControlNodein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeDistributedDatabaseCompartment
public Future<ChangeDistributedDatabaseCompartmentResponse> changeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest request, AsyncHandler<ChangeDistributedDatabaseCompartmentRequest,ChangeDistributedDatabaseCompartmentResponse> handler)
Description copied from interface:DistributedDbServiceAsyncMove the Globally distributed database and its dependent resources to the specified compartment.- Specified by:
changeDistributedDatabaseCompartmentin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeDistributedDbBackupConfig
public Future<ChangeDistributedDbBackupConfigResponse> changeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest request, AsyncHandler<ChangeDistributedDbBackupConfigRequest,ChangeDistributedDbBackupConfigResponse> handler)
Description copied from interface:DistributedDbServiceAsyncChange the DbBackupConfig for the Globally distributed database.- Specified by:
changeDistributedDbBackupConfigin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
configureDistributedDatabaseAutoResourceManagement
public Future<ConfigureDistributedDatabaseAutoResourceManagementResponse> configureDistributedDatabaseAutoResourceManagement(ConfigureDistributedDatabaseAutoResourceManagementRequest request, AsyncHandler<ConfigureDistributedDatabaseAutoResourceManagementRequest,ConfigureDistributedDatabaseAutoResourceManagementResponse> handler)
Description copied from interface:DistributedDbServiceAsyncConfigure autoResourceManagement options for the Globally distributed database.- Specified by:
configureDistributedDatabaseAutoResourceManagementin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
configureDistributedDatabaseGsms
public Future<ConfigureDistributedDatabaseGsmsResponse> configureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest request, AsyncHandler<ConfigureDistributedDatabaseGsmsRequest,ConfigureDistributedDatabaseGsmsResponse> handler)
Description copied from interface:DistributedDbServiceAsyncConfigure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.- Specified by:
configureDistributedDatabaseGsmsin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
configureDistributedDatabaseSharding
public Future<ConfigureDistributedDatabaseShardingResponse> configureDistributedDatabaseSharding(ConfigureDistributedDatabaseShardingRequest request, AsyncHandler<ConfigureDistributedDatabaseShardingRequest,ConfigureDistributedDatabaseShardingResponse> handler)
Description copied from interface:DistributedDbServiceAsyncOnce 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:
configureDistributedDatabaseShardingin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createDistributedDatabase
public Future<CreateDistributedDatabaseResponse> createDistributedDatabase(CreateDistributedDatabaseRequest request, AsyncHandler<CreateDistributedDatabaseRequest,CreateDistributedDatabaseResponse> handler)
Description copied from interface:DistributedDbServiceAsyncCreates a Globally distributed database.- Specified by:
createDistributedDatabasein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteDistributedDatabase
public Future<DeleteDistributedDatabaseResponse> deleteDistributedDatabase(DeleteDistributedDatabaseRequest request, AsyncHandler<DeleteDistributedDatabaseRequest,DeleteDistributedDatabaseResponse> handler)
Description copied from interface:DistributedDbServiceAsyncTerminate the given Globally distributed database.- Specified by:
deleteDistributedDatabasein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
generateDistributedDatabaseWallet
public Future<GenerateDistributedDatabaseWalletResponse> generateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest request, AsyncHandler<GenerateDistributedDatabaseWalletRequest,GenerateDistributedDatabaseWalletResponse> handler)
Description copied from interface:DistributedDbServiceAsyncGenerate the wallet associated with Globally distributed database.- Specified by:
generateDistributedDatabaseWalletin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDistributedDatabase
public Future<GetDistributedDatabaseResponse> getDistributedDatabase(GetDistributedDatabaseRequest request, AsyncHandler<GetDistributedDatabaseRequest,GetDistributedDatabaseResponse> handler)
Description copied from interface:DistributedDbServiceAsyncGets the details of the Globally distributed database identified by given id.- Specified by:
getDistributedDatabasein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
getDistributedDatabaseRaftMetric
public Future<GetDistributedDatabaseRaftMetricResponse> getDistributedDatabaseRaftMetric(GetDistributedDatabaseRaftMetricRequest request, AsyncHandler<GetDistributedDatabaseRaftMetricRequest,GetDistributedDatabaseRaftMetricResponse> handler)
Description copied from interface:DistributedDbServiceAsyncOperation to retrieve RAFT metrics for the Globally distributed database.If the Globally distributed database is not RAFT based then empty response is returned from the API.
- Specified by:
getDistributedDatabaseRaftMetricin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
getDistributedDatabaseRuChangeLog
public Future<GetDistributedDatabaseRuChangeLogResponse> getDistributedDatabaseRuChangeLog(GetDistributedDatabaseRuChangeLogRequest request, AsyncHandler<GetDistributedDatabaseRuChangeLogRequest,GetDistributedDatabaseRuChangeLogResponse> handler)
Description copied from interface:DistributedDbServiceAsyncOperation to retrieve move RU invocation history and status for the Globally distributed database.Results are ordered by created timestamp in descending order.
- Specified by:
getDistributedDatabaseRuChangeLogin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDistributedDatabases
public Future<ListDistributedDatabasesResponse> listDistributedDatabases(ListDistributedDatabasesRequest request, AsyncHandler<ListDistributedDatabasesRequest,ListDistributedDatabasesResponse> handler)
Description copied from interface:DistributedDbServiceAsyncList of Globally distributed databases.- Specified by:
listDistributedDatabasesin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
moveDistributedDatabaseReplicationUnit
public Future<MoveDistributedDatabaseReplicationUnitResponse> moveDistributedDatabaseReplicationUnit(MoveDistributedDatabaseReplicationUnitRequest request, AsyncHandler<MoveDistributedDatabaseReplicationUnitRequest,MoveDistributedDatabaseReplicationUnitResponse> handler)
Description copied from interface:DistributedDbServiceAsyncMove the replication units for RAFT based globally distributed database from source shard to destination shard.- Specified by:
moveDistributedDatabaseReplicationUnitin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
patchDistributedDatabase
public Future<PatchDistributedDatabaseResponse> patchDistributedDatabase(PatchDistributedDatabaseRequest request, AsyncHandler<PatchDistributedDatabaseRequest,PatchDistributedDatabaseResponse> handler)
Description copied from interface:DistributedDbServiceAsyncPatch 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:
patchDistributedDatabasein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
recreateFailedDistributedDatabaseResource
public Future<RecreateFailedDistributedDatabaseResourceResponse> recreateFailedDistributedDatabaseResource(RecreateFailedDistributedDatabaseResourceRequest request, AsyncHandler<RecreateFailedDistributedDatabaseResourceRequest,RecreateFailedDistributedDatabaseResourceResponse> handler)
Description copied from interface:DistributedDbServiceAsyncRecreate the failed resource for the Globally Distributed Database.- Specified by:
recreateFailedDistributedDatabaseResourcein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
rotateDistributedDatabasePasswords
public Future<RotateDistributedDatabasePasswordsResponse> rotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request, AsyncHandler<RotateDistributedDatabasePasswordsRequest,RotateDistributedDatabasePasswordsResponse> handler)
Description copied from interface:DistributedDbServiceAsyncRotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed database.This operation will also remove GdsCtlNodes if present.
- Specified by:
rotateDistributedDatabasePasswordsin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
scaleDistributedDatabaseGsms
public Future<ScaleDistributedDatabaseGsmsResponse> scaleDistributedDatabaseGsms(ScaleDistributedDatabaseGsmsRequest request, AsyncHandler<ScaleDistributedDatabaseGsmsRequest,ScaleDistributedDatabaseGsmsResponse> handler)
Description copied from interface:DistributedDbServiceAsyncScale global service manager(GSM aka shard manager) instances for the Globally distributed database.- Specified by:
scaleDistributedDatabaseGsmsin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
startDistributedDatabase
public Future<StartDistributedDatabaseResponse> startDistributedDatabase(StartDistributedDatabaseRequest request, AsyncHandler<StartDistributedDatabaseRequest,StartDistributedDatabaseResponse> handler)
Description copied from interface:DistributedDbServiceAsyncStart the shards, catalog, GSMs and GDSCTL instances of Globally distributed database.- Specified by:
startDistributedDatabasein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
stopDistributedDatabase
public Future<StopDistributedDatabaseResponse> stopDistributedDatabase(StopDistributedDatabaseRequest request, AsyncHandler<StopDistributedDatabaseRequest,StopDistributedDatabaseResponse> handler)
Description copied from interface:DistributedDbServiceAsyncStop the shards, catalog, GSMs and GDSCTL instances for the Globally distributed database.- Specified by:
stopDistributedDatabasein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateDistributedDatabase
public Future<UpdateDistributedDatabaseResponse> updateDistributedDatabase(UpdateDistributedDatabaseRequest request, AsyncHandler<UpdateDistributedDatabaseRequest,UpdateDistributedDatabaseResponse> handler)
Description copied from interface:DistributedDbServiceAsyncUpdates the configuration of the Globally distributed database.- Specified by:
updateDistributedDatabasein interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
validateDistributedDatabaseNetwork
public Future<ValidateDistributedDatabaseNetworkResponse> validateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request, AsyncHandler<ValidateDistributedDatabaseNetworkRequest,ValidateDistributedDatabaseNetworkResponse> handler)
Description copied from interface:DistributedDbServiceAsyncValidate the network connectivity between components of the globally distributed database.- Specified by:
validateDistributedDatabaseNetworkin interfaceDistributedDbServiceAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.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)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
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)
-
-