@Generated(value="OracleSDKGenerator", comments="API Version: 20190415") public class DbSystemAsyncClient extends Object implements DbSystemAsync
Async client implementation for DbSystem 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
| Modifier and Type | Class and Description |
|---|---|
static class |
DbSystemAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for DbSystem.
|
| Constructor and Description |
|---|
DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for DbSystem.
public DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public DbSystemAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public DbSystemAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public static DbSystemAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
DbSystemAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface DbSystemAsyncendpoint - The endpoint of the serice.public void setRegion(Region region)
DbSystemAsyncSets 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.
setRegion in interface DbSystemAsyncregion - The region of the service.public void setRegion(String regionId)
DbSystemAsyncSets 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.
setRegion in interface DbSystemAsyncregionId - The public region ID.public void close()
close in interface AutoCloseablepublic Future<CreateDbSystemResponse> createDbSystem(CreateDbSystemRequest request, AsyncHandler<CreateDbSystemRequest,CreateDbSystemResponse> handler)
DbSystemAsyncCreates and launches a DB System.
createDbSystem in interface DbSystemAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteDbSystemResponse> deleteDbSystem(DeleteDbSystemRequest request, AsyncHandler<DeleteDbSystemRequest,DeleteDbSystemResponse> handler)
DbSystemAsyncDelete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
deleteDbSystem in interface DbSystemAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetDbSystemResponse> getDbSystem(GetDbSystemRequest request, AsyncHandler<GetDbSystemRequest,GetDbSystemResponse> handler)
DbSystemAsyncGet information about the specified DB System.
getDbSystem in interface DbSystemAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListDbSystemsResponse> listDbSystems(ListDbSystemsRequest request, AsyncHandler<ListDbSystemsRequest,ListDbSystemsResponse> handler)
DbSystemAsyncGet a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.
listDbSystems in interface DbSystemAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<RestartDbSystemResponse> restartDbSystem(RestartDbSystemRequest request, AsyncHandler<RestartDbSystemRequest,RestartDbSystemResponse> handler)
DbSystemAsyncRestarts the specified DB System.
restartDbSystem in interface DbSystemAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<StartDbSystemResponse> startDbSystem(StartDbSystemRequest request, AsyncHandler<StartDbSystemRequest,StartDbSystemResponse> handler)
DbSystemAsyncStart the specified DB System.
startDbSystem in interface DbSystemAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<StopDbSystemResponse> stopDbSystem(StopDbSystemRequest request, AsyncHandler<StopDbSystemRequest,StopDbSystemResponse> handler)
DbSystemAsyncStops the specified DB System.
A stopped DB System is not billed.
stopDbSystem in interface DbSystemAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateDbSystemResponse> updateDbSystem(UpdateDbSystemRequest request, AsyncHandler<UpdateDbSystemRequest,UpdateDbSystemResponse> handler)
DbSystemAsyncUpdate the configuration of a DB System.
Updating different fields in the DB System will have different results on the uptime of the DB System. For example, changing the displayName of a DB System will take effect immediately, but changing the shape of a DB System is an asynchronous operation that involves provisioning new Compute resources, pausing the DB System and migrating storage before making the DB System available again.
updateDbSystem in interface DbSystemAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2020. All rights reserved.