Interface DistributedAutonomousDbServiceAsync
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
DistributedAutonomousDbServiceAsyncClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20250101") public interface DistributedAutonomousDbServiceAsync extends AutoCloseable
Use the Globally Distributed Database service APIs to create and manage the Globally distributed databases.
-
-
Method Summary
-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the serice.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
void setRegion(Region region)
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.- Parameters:
region
- The region of the service.
-
setRegion
void setRegion(String regionId)
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 callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
addDistributedAutonomousDatabaseGdsControlNode
Future<AddDistributedAutonomousDatabaseGdsControlNodeResponse> addDistributedAutonomousDatabaseGdsControlNode(AddDistributedAutonomousDatabaseGdsControlNodeRequest request, AsyncHandler<AddDistributedAutonomousDatabaseGdsControlNodeRequest,AddDistributedAutonomousDatabaseGdsControlNodeResponse> handler)
Add new Global database services control(GDS CTL) node for the Globally distributed autonomous database.- 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.
-
changeDistributedAutonomousDatabaseCompartment
Future<ChangeDistributedAutonomousDatabaseCompartmentResponse> changeDistributedAutonomousDatabaseCompartment(ChangeDistributedAutonomousDatabaseCompartmentRequest request, AsyncHandler<ChangeDistributedAutonomousDatabaseCompartmentRequest,ChangeDistributedAutonomousDatabaseCompartmentResponse> handler)
Move the Globally distributed autonomous database and its dependent resources to the specified compartment.- 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.
-
configureDistributedAutonomousDatabaseGsms
Future<ConfigureDistributedAutonomousDatabaseGsmsResponse> configureDistributedAutonomousDatabaseGsms(ConfigureDistributedAutonomousDatabaseGsmsRequest request, AsyncHandler<ConfigureDistributedAutonomousDatabaseGsmsRequest,ConfigureDistributedAutonomousDatabaseGsmsResponse> handler)
Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed autonomous database.- 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.
-
configureDistributedAutonomousDatabaseSharding
Future<ConfigureDistributedAutonomousDatabaseShardingResponse> configureDistributedAutonomousDatabaseSharding(ConfigureDistributedAutonomousDatabaseShardingRequest request, AsyncHandler<ConfigureDistributedAutonomousDatabaseShardingRequest,ConfigureDistributedAutonomousDatabaseShardingResponse> handler)
Once all components of Globally distributed autonomous database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the Globally distributed autonomous database.Note that this ‘ConfigureSharding’ API also needs to be invoked after successfully adding a new shard to the Globally distributed autonomous database using PATCH api. If this API is not invoked after successfully adding a new shard, then that new shard will not be a participant in sharding topology of the Globally distributed autonomous database.
- 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.
-
createDistributedAutonomousDatabase
Future<CreateDistributedAutonomousDatabaseResponse> createDistributedAutonomousDatabase(CreateDistributedAutonomousDatabaseRequest request, AsyncHandler<CreateDistributedAutonomousDatabaseRequest,CreateDistributedAutonomousDatabaseResponse> handler)
Creates a Globally distributed autonomous database.- 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.
-
deleteDistributedAutonomousDatabase
Future<DeleteDistributedAutonomousDatabaseResponse> deleteDistributedAutonomousDatabase(DeleteDistributedAutonomousDatabaseRequest request, AsyncHandler<DeleteDistributedAutonomousDatabaseRequest,DeleteDistributedAutonomousDatabaseResponse> handler)
Terminate the given Globally distributed autonomous databases.- 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.
-
downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest
Future<DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> downloadDistributedAutonomousDatabaseGsmCertificateSigningRequest(DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request, AsyncHandler<DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest,DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> handler)
Generate the common certificate signing request for GSMs.Download the
.csr file from API response. Users can use this .csr file to generate the CA signed certificate, and as a next step use ‘uploadSignedCertificateAndGenerateWallet’ API to upload the CA signed certificate to GSM, and generate wallets for the GSM instances of the Globally distributed autonomous database. - 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.
-
generateDistributedAutonomousDatabaseGsmCertificateSigningRequest
Future<GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> generateDistributedAutonomousDatabaseGsmCertificateSigningRequest(GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest request, AsyncHandler<GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestRequest,GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequestResponse> handler)
Generate the certificate signing request for GSM instances of the Globally distributed autonomous database.Once certificate signing request is generated, then customers can download the certificate signing request using ‘downloadGsmCertificateSigningRequest’ api call.
- 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.
-
generateDistributedAutonomousDatabaseWallet
Future<GenerateDistributedAutonomousDatabaseWalletResponse> generateDistributedAutonomousDatabaseWallet(GenerateDistributedAutonomousDatabaseWalletRequest request, AsyncHandler<GenerateDistributedAutonomousDatabaseWalletRequest,GenerateDistributedAutonomousDatabaseWalletResponse> handler)
Generate the wallet associated with Globally distributed autonomous database.- 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.
-
getDistributedAutonomousDatabase
Future<GetDistributedAutonomousDatabaseResponse> getDistributedAutonomousDatabase(GetDistributedAutonomousDatabaseRequest request, AsyncHandler<GetDistributedAutonomousDatabaseRequest,GetDistributedAutonomousDatabaseResponse> handler)
Gets the details of the Globally distributed autonomous database identified by given id.- 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.
-
listDistributedAutonomousDatabases
Future<ListDistributedAutonomousDatabasesResponse> listDistributedAutonomousDatabases(ListDistributedAutonomousDatabasesRequest request, AsyncHandler<ListDistributedAutonomousDatabasesRequest,ListDistributedAutonomousDatabasesResponse> handler)
List of Globally distributed autonomous databases.- 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.
-
patchDistributedAutonomousDatabase
Future<PatchDistributedAutonomousDatabaseResponse> patchDistributedAutonomousDatabase(PatchDistributedAutonomousDatabaseRequest request, AsyncHandler<PatchDistributedAutonomousDatabaseRequest,PatchDistributedAutonomousDatabaseResponse> handler)
Patch operation to add, remove or update shards to the Globally distributed autonomous database topology.In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.
- 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.
-
rotateDistributedAutonomousDatabasePasswords
Future<RotateDistributedAutonomousDatabasePasswordsResponse> rotateDistributedAutonomousDatabasePasswords(RotateDistributedAutonomousDatabasePasswordsRequest request, AsyncHandler<RotateDistributedAutonomousDatabasePasswordsRequest,RotateDistributedAutonomousDatabasePasswordsResponse> handler)
Rotate passwords for different components of the Globally distributed autonomous database.- 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.
-
startDistributedAutonomousDatabase
Future<StartDistributedAutonomousDatabaseResponse> startDistributedAutonomousDatabase(StartDistributedAutonomousDatabaseRequest request, AsyncHandler<StartDistributedAutonomousDatabaseRequest,StartDistributedAutonomousDatabaseResponse> handler)
Start the shards, catalog and GSMs of Globally distributed autonomous database.- 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.
-
stopDistributedAutonomousDatabase
Future<StopDistributedAutonomousDatabaseResponse> stopDistributedAutonomousDatabase(StopDistributedAutonomousDatabaseRequest request, AsyncHandler<StopDistributedAutonomousDatabaseRequest,StopDistributedAutonomousDatabaseResponse> handler)
Stop the shards, catalog and GSM instances for the Globally distributed autonomous database.- 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.
-
updateDistributedAutonomousDatabase
Future<UpdateDistributedAutonomousDatabaseResponse> updateDistributedAutonomousDatabase(UpdateDistributedAutonomousDatabaseRequest request, AsyncHandler<UpdateDistributedAutonomousDatabaseRequest,UpdateDistributedAutonomousDatabaseResponse> handler)
Updates the configuration of the Globally distributed autonomous database.- 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.
-
uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet
Future<UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletResponse> uploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet(UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletRequest request, AsyncHandler<UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletRequest,UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletResponse> handler)
Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the Globally distributed autonomous database.Customer shall provide the CA signed certificate key details by adding the certificate in request body.
- 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.
-
validateDistributedAutonomousDatabaseNetwork
Future<ValidateDistributedAutonomousDatabaseNetworkResponse> validateDistributedAutonomousDatabaseNetwork(ValidateDistributedAutonomousDatabaseNetworkRequest request, AsyncHandler<ValidateDistributedAutonomousDatabaseNetworkRequest,ValidateDistributedAutonomousDatabaseNetworkResponse> handler)
Validate the network connectivity between components of the globally distributed autonomous database.- 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.
-
-