@Generated(value="OracleSDKGenerator", comments="API Version: 20230301") public interface ShardedDatabaseServiceAsync extends AutoCloseable
Use the Globally Distributed Database service APIs to create and manage distributed databases.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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 call setEndpoint
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<ChangePrivateEndpointCompartmentResponse> changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request, AsyncHandler<ChangePrivateEndpointCompartmentRequest,ChangePrivateEndpointCompartmentResponse> handler)
Move the private endpoint to the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeShardedDatabaseCompartmentResponse> changeShardedDatabaseCompartment(ChangeShardedDatabaseCompartmentRequest request, AsyncHandler<ChangeShardedDatabaseCompartmentRequest,ChangeShardedDatabaseCompartmentResponse> handler)
Move the sharded database database and its dependent resources to the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ConfigureShardedDatabaseGsmsResponse> configureShardedDatabaseGsms(ConfigureShardedDatabaseGsmsRequest request, AsyncHandler<ConfigureShardedDatabaseGsmsRequest,ConfigureShardedDatabaseGsmsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.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. 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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreatePrivateEndpointResponse> createPrivateEndpoint(CreatePrivateEndpointRequest request, AsyncHandler<CreatePrivateEndpointRequest,CreatePrivateEndpointResponse> handler)
Creates a PrivateEndpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateShardedDatabaseResponse> createShardedDatabase(CreateShardedDatabaseRequest request, AsyncHandler<CreateShardedDatabaseRequest,CreateShardedDatabaseResponse> handler)
Creates a Sharded Database.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeletePrivateEndpointResponse> deletePrivateEndpoint(DeletePrivateEndpointRequest request, AsyncHandler<DeletePrivateEndpointRequest,DeletePrivateEndpointResponse> handler)
Delete the given private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteShardedDatabaseResponse> deleteShardedDatabase(DeleteShardedDatabaseRequest request, AsyncHandler<DeleteShardedDatabaseRequest,DeleteShardedDatabaseResponse> handler)
Terminate the given sharded databases.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DownloadGsmCertificateSigningRequestResponse> downloadGsmCertificateSigningRequest(DownloadGsmCertificateSigningRequestRequest request, AsyncHandler<DownloadGsmCertificateSigningRequestRequest,DownloadGsmCertificateSigningRequestResponse> handler)
Generate the common certificate signing request for GSMs. Download the
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<FetchConnectionStringResponse> fetchConnectionString(FetchConnectionStringRequest request, AsyncHandler<FetchConnectionStringRequest,FetchConnectionStringResponse> handler)
Gets the Sharded Database Connection Strings.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<FetchShardableCloudAutonomousVmClustersResponse> fetchShardableCloudAutonomousVmClusters(FetchShardableCloudAutonomousVmClustersRequest request, AsyncHandler<FetchShardableCloudAutonomousVmClustersRequest,FetchShardableCloudAutonomousVmClustersResponse> handler)
List of cloudAutonomousVMClusters for the given tenancy, that can be sharded.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GenerateGsmCertificateSigningRequestResponse> generateGsmCertificateSigningRequest(GenerateGsmCertificateSigningRequestRequest request, AsyncHandler<GenerateGsmCertificateSigningRequestRequest,GenerateGsmCertificateSigningRequestResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GenerateWalletResponse> generateWallet(GenerateWalletRequest request, AsyncHandler<GenerateWalletRequest,GenerateWalletResponse> handler)
Generate the wallet associated with sharded database.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetPrivateEndpointResponse> getPrivateEndpoint(GetPrivateEndpointRequest request, AsyncHandler<GetPrivateEndpointRequest,GetPrivateEndpointResponse> handler)
Get the PrivateEndpoint resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetShardedDatabaseResponse> getShardedDatabase(GetShardedDatabaseRequest request, AsyncHandler<GetShardedDatabaseRequest,GetShardedDatabaseResponse> handler)
Gets the details of the Sharded database identified by given id.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets details of the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListPrivateEndpointsResponse> listPrivateEndpoints(ListPrivateEndpointsRequest request, AsyncHandler<ListPrivateEndpointsRequest,ListPrivateEndpointsResponse> handler)
List of PrivateEndpoints.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListShardedDatabasesResponse> listShardedDatabases(ListShardedDatabasesRequest request, AsyncHandler<ListShardedDatabasesRequest,ListShardedDatabasesResponse> handler)
List of Sharded databases.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Returns a (paginated) list of errors for the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Returns a (paginated) list of logs for the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<PatchShardedDatabaseResponse> patchShardedDatabase(PatchShardedDatabaseRequest request, AsyncHandler<PatchShardedDatabaseRequest,PatchShardedDatabaseResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<PrevalidateShardedDatabaseResponse> prevalidateShardedDatabase(PrevalidateShardedDatabaseRequest request, AsyncHandler<PrevalidateShardedDatabaseRequest,PrevalidateShardedDatabaseResponse> handler)
Sharded database pre-validation request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ReinstateProxyInstanceResponse> reinstateProxyInstance(ReinstateProxyInstanceRequest request, AsyncHandler<ReinstateProxyInstanceRequest,ReinstateProxyInstanceResponse> handler)
API to reinstate the proxy instances associated with the private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<StartShardedDatabaseResponse> startShardedDatabase(StartShardedDatabaseRequest request, AsyncHandler<StartShardedDatabaseRequest,StartShardedDatabaseResponse> handler)
Start the shards, catalog and GSMs of Sharded Database.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<StopShardedDatabaseResponse> stopShardedDatabase(StopShardedDatabaseRequest request, AsyncHandler<StopShardedDatabaseRequest,StopShardedDatabaseResponse> handler)
Stop the shards, catalog and GSM instances for the sharded database.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdatePrivateEndpointResponse> updatePrivateEndpoint(UpdatePrivateEndpointRequest request, AsyncHandler<UpdatePrivateEndpointRequest,UpdatePrivateEndpointResponse> handler)
Updates the configuration of privateendpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateShardedDatabaseResponse> updateShardedDatabase(UpdateShardedDatabaseRequest request, AsyncHandler<UpdateShardedDatabaseRequest,UpdateShardedDatabaseResponse> handler)
Updates the configuration of sharded database.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.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. Customer shall provide the CA signed certificate key details by adding the certificate in request body.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ValidateNetworkResponse> validateNetwork(ValidateNetworkRequest request, AsyncHandler<ValidateNetworkRequest,ValidateNetworkResponse> handler)
Validate the network connectivity between components of sharded database.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.