@Generated(value="OracleSDKGenerator", comments="API Version: 20201005") public class DatabaseToolsAsyncClient extends Object implements DatabaseToolsAsync
Async client implementation for DatabaseTools service.
There are two ways to use async client:
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. Modifier and Type | Class and Description |
---|---|
static class |
DatabaseToolsAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for DatabaseTools.
|
Constructor and Description |
---|
DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
DatabaseToolsAsyncClient(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.
|
DatabaseToolsAsyncClient(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.
|
DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
DatabaseToolsAsyncClient(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 DatabaseTools.
public DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public DatabaseToolsAsyncClient(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 DatabaseToolsAsyncClient(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 DatabaseToolsAsyncClient(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 DatabaseToolsAsyncClient(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 DatabaseToolsAsyncClient(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 DatabaseToolsAsyncClient(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 DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
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
)restClientFactoryBuilder
- the builder for the RestClientFactory
public static DatabaseToolsAsyncClient.Builder builder()
Create a builder for this client.
public void refreshClient()
DatabaseToolsAsync
Rebuilds the client from scratch. Useful to refresh certificates.
refreshClient
in interface DatabaseToolsAsync
public void setEndpoint(String endpoint)
DatabaseToolsAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface DatabaseToolsAsync
endpoint
- The endpoint of the serice.public String getEndpoint()
DatabaseToolsAsync
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface DatabaseToolsAsync
public void setRegion(Region region)
DatabaseToolsAsync
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.
setRegion
in interface DatabaseToolsAsync
region
- The region of the service.public void setRegion(String regionId)
DatabaseToolsAsync
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
.
setRegion
in interface DatabaseToolsAsync
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public Future<ChangeDatabaseToolsConnectionCompartmentResponse> changeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest request, AsyncHandler<ChangeDatabaseToolsConnectionCompartmentRequest,ChangeDatabaseToolsConnectionCompartmentResponse> handler)
DatabaseToolsAsync
Moves the specified Database Tools connection to a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeDatabaseToolsConnectionCompartment
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeDatabaseToolsPrivateEndpointCompartmentResponse> changeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request, AsyncHandler<ChangeDatabaseToolsPrivateEndpointCompartmentRequest,ChangeDatabaseToolsPrivateEndpointCompartmentResponse> handler)
DatabaseToolsAsync
Moves a Database Tools private endpoint into a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeDatabaseToolsPrivateEndpointCompartment
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDatabaseToolsConnectionResponse> createDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request, AsyncHandler<CreateDatabaseToolsConnectionRequest,CreateDatabaseToolsConnectionResponse> handler)
DatabaseToolsAsync
Creates a new Database Tools connection.
createDatabaseToolsConnection
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDatabaseToolsPrivateEndpointResponse> createDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request, AsyncHandler<CreateDatabaseToolsPrivateEndpointRequest,CreateDatabaseToolsPrivateEndpointResponse> handler)
DatabaseToolsAsync
Creates a new Database Tools private endpoint.
createDatabaseToolsPrivateEndpoint
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDatabaseToolsConnectionResponse> deleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request, AsyncHandler<DeleteDatabaseToolsConnectionRequest,DeleteDatabaseToolsConnectionResponse> handler)
DatabaseToolsAsync
Deletes the specified Database Tools connection resource.
deleteDatabaseToolsConnection
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDatabaseToolsPrivateEndpointResponse> deleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request, AsyncHandler<DeleteDatabaseToolsPrivateEndpointRequest,DeleteDatabaseToolsPrivateEndpointResponse> handler)
DatabaseToolsAsync
Deletes the specified Database Tools private endpoint.
deleteDatabaseToolsPrivateEndpoint
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDatabaseToolsConnectionResponse> getDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request, AsyncHandler<GetDatabaseToolsConnectionRequest,GetDatabaseToolsConnectionResponse> handler)
DatabaseToolsAsync
Gets details of the specified Database Tools connection.
getDatabaseToolsConnection
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDatabaseToolsEndpointServiceResponse> getDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request, AsyncHandler<GetDatabaseToolsEndpointServiceRequest,GetDatabaseToolsEndpointServiceResponse> handler)
DatabaseToolsAsync
Gets details for the specified Database Tools endpoint service.
getDatabaseToolsEndpointService
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDatabaseToolsPrivateEndpointResponse> getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request, AsyncHandler<GetDatabaseToolsPrivateEndpointRequest,GetDatabaseToolsPrivateEndpointResponse> handler)
DatabaseToolsAsync
Gets details of a specified Database Tools private endpoint.
getDatabaseToolsPrivateEndpoint
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
DatabaseToolsAsync
Gets the status of the specified work request.
getWorkRequest
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDatabaseToolsConnectionsResponse> listDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request, AsyncHandler<ListDatabaseToolsConnectionsRequest,ListDatabaseToolsConnectionsResponse> handler)
DatabaseToolsAsync
Returns a list of Database Tools connections.
listDatabaseToolsConnections
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDatabaseToolsEndpointServicesResponse> listDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request, AsyncHandler<ListDatabaseToolsEndpointServicesRequest,ListDatabaseToolsEndpointServicesResponse> handler)
DatabaseToolsAsync
Returns a list of Database Tools endpoint services.
listDatabaseToolsEndpointServices
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDatabaseToolsPrivateEndpointsResponse> listDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request, AsyncHandler<ListDatabaseToolsPrivateEndpointsRequest,ListDatabaseToolsPrivateEndpointsResponse> handler)
DatabaseToolsAsync
Returns a list of Database Tools private endpoints.
listDatabaseToolsPrivateEndpoints
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
DatabaseToolsAsync
Returns a paginated list of errors for the specified work request.
listWorkRequestErrors
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
DatabaseToolsAsync
Returns a paginated list of logs for the specified work request.
listWorkRequestLogs
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
DatabaseToolsAsync
Lists the work requests in a compartment.
listWorkRequests
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDatabaseToolsConnectionResponse> updateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request, AsyncHandler<UpdateDatabaseToolsConnectionRequest,UpdateDatabaseToolsConnectionResponse> handler)
DatabaseToolsAsync
Updates the specified Database Tools connection.
updateDatabaseToolsConnection
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDatabaseToolsPrivateEndpointResponse> updateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request, AsyncHandler<UpdateDatabaseToolsPrivateEndpointRequest,UpdateDatabaseToolsPrivateEndpointResponse> handler)
DatabaseToolsAsync
Updates the specified Database Tools private endpoint.
updateDatabaseToolsPrivateEndpoint
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ValidateDatabaseToolsConnectionResponse> validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request, AsyncHandler<ValidateDatabaseToolsConnectionRequest,ValidateDatabaseToolsConnectionResponse> handler)
DatabaseToolsAsync
Validates the Database Tools connection details by establishing a connection to the database.
validateDatabaseToolsConnection
in interface DatabaseToolsAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.