com.oracle.bmc.databasetools

Class DatabaseToolsAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.databasetools.DatabaseToolsAsyncClient

All Implemented Interfaces:

DatabaseToolsAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201005")
public class DatabaseToolsAsyncClient
extends BaseAsyncClient
implements DatabaseToolsAsync

Async client implementation for DatabaseTools 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseToolsAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for DatabaseTools.

Constructor Summary

Constructors

Constructor and Description
DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
Future<AddDatabaseToolsConnectionLockResponse>	addDatabaseToolsConnectionLock(AddDatabaseToolsConnectionLockRequest request, AsyncHandler<AddDatabaseToolsConnectionLockRequest,AddDatabaseToolsConnectionLockResponse> handler) Adds a lock to a DatabaseToolsConnection resource.
Future<AddDatabaseToolsPrivateEndpointLockResponse>	addDatabaseToolsPrivateEndpointLock(AddDatabaseToolsPrivateEndpointLockRequest request, AsyncHandler<AddDatabaseToolsPrivateEndpointLockRequest,AddDatabaseToolsPrivateEndpointLockResponse> handler) Adds a lock to a DatabaseToolsPrivateEndpoint resource.
static DatabaseToolsAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeDatabaseToolsConnectionCompartmentResponse>	changeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest request, AsyncHandler<ChangeDatabaseToolsConnectionCompartmentRequest,ChangeDatabaseToolsConnectionCompartmentResponse> handler) Moves the specified Database Tools connection to a different compartment in the same tenancy.
Future<ChangeDatabaseToolsPrivateEndpointCompartmentResponse>	changeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request, AsyncHandler<ChangeDatabaseToolsPrivateEndpointCompartmentRequest,ChangeDatabaseToolsPrivateEndpointCompartmentResponse> handler) Moves a Database Tools private endpoint into a different compartment in the same tenancy.
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)
void	close()
Future<CreateDatabaseToolsConnectionResponse>	createDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request, AsyncHandler<CreateDatabaseToolsConnectionRequest,CreateDatabaseToolsConnectionResponse> handler) Creates a new Database Tools connection.
Future<CreateDatabaseToolsPrivateEndpointResponse>	createDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request, AsyncHandler<CreateDatabaseToolsPrivateEndpointRequest,CreateDatabaseToolsPrivateEndpointResponse> handler) Creates a new Database Tools private endpoint.
Future<DeleteDatabaseToolsConnectionResponse>	deleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request, AsyncHandler<DeleteDatabaseToolsConnectionRequest,DeleteDatabaseToolsConnectionResponse> handler) Deletes the specified Database Tools connection resource.
Future<DeleteDatabaseToolsPrivateEndpointResponse>	deleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request, AsyncHandler<DeleteDatabaseToolsPrivateEndpointRequest,DeleteDatabaseToolsPrivateEndpointResponse> handler) Deletes the specified Database Tools private endpoint.
String	getClientCommonLibraryVersion()
Future<GetDatabaseToolsConnectionResponse>	getDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request, AsyncHandler<GetDatabaseToolsConnectionRequest,GetDatabaseToolsConnectionResponse> handler) Gets details of the specified Database Tools connection.
Future<GetDatabaseToolsEndpointServiceResponse>	getDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request, AsyncHandler<GetDatabaseToolsEndpointServiceRequest,GetDatabaseToolsEndpointServiceResponse> handler) Gets details for the specified Database Tools endpoint service.
Future<GetDatabaseToolsPrivateEndpointResponse>	getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request, AsyncHandler<GetDatabaseToolsPrivateEndpointRequest,GetDatabaseToolsPrivateEndpointResponse> handler) Gets details of a specified Database Tools private endpoint.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the specified work request.
Future<ListDatabaseToolsConnectionsResponse>	listDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request, AsyncHandler<ListDatabaseToolsConnectionsRequest,ListDatabaseToolsConnectionsResponse> handler) Returns a list of Database Tools connections.
Future<ListDatabaseToolsEndpointServicesResponse>	listDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request, AsyncHandler<ListDatabaseToolsEndpointServicesRequest,ListDatabaseToolsEndpointServicesResponse> handler) Returns a list of Database Tools endpoint services.
Future<ListDatabaseToolsPrivateEndpointsResponse>	listDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request, AsyncHandler<ListDatabaseToolsPrivateEndpointsRequest,ListDatabaseToolsPrivateEndpointsResponse> handler) Returns a list of Database Tools private endpoints.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Returns a paginated list of errors for the specified work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Returns a paginated list of logs for the specified work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
Future<RemoveDatabaseToolsConnectionLockResponse>	removeDatabaseToolsConnectionLock(RemoveDatabaseToolsConnectionLockRequest request, AsyncHandler<RemoveDatabaseToolsConnectionLockRequest,RemoveDatabaseToolsConnectionLockResponse> handler) Removes a lock from a DatabaseToolsConnection resource.
Future<RemoveDatabaseToolsPrivateEndpointLockResponse>	removeDatabaseToolsPrivateEndpointLock(RemoveDatabaseToolsPrivateEndpointLockRequest request, AsyncHandler<RemoveDatabaseToolsPrivateEndpointLockRequest,RemoveDatabaseToolsPrivateEndpointLockResponse> handler) Removes a lock from a DatabaseToolsPrivateEndpoint resource.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateDatabaseToolsConnectionResponse>	updateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request, AsyncHandler<UpdateDatabaseToolsConnectionRequest,UpdateDatabaseToolsConnectionResponse> handler) Updates the specified Database Tools connection.
Future<UpdateDatabaseToolsPrivateEndpointResponse>	updateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request, AsyncHandler<UpdateDatabaseToolsPrivateEndpointRequest,UpdateDatabaseToolsPrivateEndpointResponse> handler) Updates the specified Database Tools private endpoint.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.
Future<ValidateDatabaseToolsConnectionResponse>	validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request, AsyncHandler<ValidateDatabaseToolsConnectionRequest,ValidateDatabaseToolsConnectionResponse> handler) Validates the Database Tools connection details by establishing a connection to the database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.databasetools.DatabaseToolsAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DatabaseTools.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

DatabaseToolsAsyncClient

@Deprecated
public DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseToolsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DatabaseToolsAsyncClient

@Deprecated
public DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                            ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseToolsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DatabaseToolsAsyncClient

@Deprecated
public DatabaseToolsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                            ClientConfiguration configuration,
                                            ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseToolsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DatabaseToolsAsyncClient

@Deprecated
public DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                            ClientConfiguration configuration,
                                            ClientConfigurator clientConfigurator,
                                            RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseToolsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DatabaseToolsAsyncClient

@Deprecated
public DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                            ClientConfiguration configuration,
                                            ClientConfigurator clientConfigurator,
                                            RequestSignerFactory defaultRequestSignerFactory,
                                            List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseToolsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DatabaseToolsAsyncClient

@Deprecated
public DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                            ClientConfiguration configuration,
                                            ClientConfigurator clientConfigurator,
                                            RequestSignerFactory defaultRequestSignerFactory,
                                            List<ClientConfigurator> additionalClientConfigurators,
                                            String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseToolsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

DatabaseToolsAsyncClient

@Deprecated
public DatabaseToolsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                            ClientConfiguration configuration,
                                            ClientConfigurator clientConfigurator,
                                            RequestSignerFactory defaultRequestSignerFactory,
                                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                            List<ClientConfigurator> additionalClientConfigurators,
                                            String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseToolsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static DatabaseToolsAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: 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.

Specified by:

setRegion in interface DatabaseToolsAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface DatabaseToolsAsync

Parameters:

regionId - The public region ID.

addDatabaseToolsConnectionLock

public Future<AddDatabaseToolsConnectionLockResponse> addDatabaseToolsConnectionLock(AddDatabaseToolsConnectionLockRequest request,
                                                                                     AsyncHandler<AddDatabaseToolsConnectionLockRequest,AddDatabaseToolsConnectionLockResponse> handler)

Description copied from interface: DatabaseToolsAsync

Adds a lock to a DatabaseToolsConnection resource.

Specified by:

addDatabaseToolsConnectionLock in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

addDatabaseToolsPrivateEndpointLock

public Future<AddDatabaseToolsPrivateEndpointLockResponse> addDatabaseToolsPrivateEndpointLock(AddDatabaseToolsPrivateEndpointLockRequest request,
                                                                                               AsyncHandler<AddDatabaseToolsPrivateEndpointLockRequest,AddDatabaseToolsPrivateEndpointLockResponse> handler)

Description copied from interface: DatabaseToolsAsync

Adds a lock to a DatabaseToolsPrivateEndpoint resource.

Specified by:

addDatabaseToolsPrivateEndpointLock in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

changeDatabaseToolsConnectionCompartment

public Future<ChangeDatabaseToolsConnectionCompartmentResponse> changeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest request,
                                                                                                         AsyncHandler<ChangeDatabaseToolsConnectionCompartmentRequest,ChangeDatabaseToolsConnectionCompartmentResponse> handler)

Description copied from interface: 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.

Specified by:

changeDatabaseToolsConnectionCompartment in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

changeDatabaseToolsPrivateEndpointCompartment

public Future<ChangeDatabaseToolsPrivateEndpointCompartmentResponse> changeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request,
                                                                                                                   AsyncHandler<ChangeDatabaseToolsPrivateEndpointCompartmentRequest,ChangeDatabaseToolsPrivateEndpointCompartmentResponse> handler)

Description copied from interface: 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.

Specified by:

changeDatabaseToolsPrivateEndpointCompartment in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

createDatabaseToolsConnection

public Future<CreateDatabaseToolsConnectionResponse> createDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request,
                                                                                   AsyncHandler<CreateDatabaseToolsConnectionRequest,CreateDatabaseToolsConnectionResponse> handler)

Description copied from interface: DatabaseToolsAsync

Creates a new Database Tools connection.

Specified by:

createDatabaseToolsConnection in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

createDatabaseToolsPrivateEndpoint

public Future<CreateDatabaseToolsPrivateEndpointResponse> createDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request,
                                                                                             AsyncHandler<CreateDatabaseToolsPrivateEndpointRequest,CreateDatabaseToolsPrivateEndpointResponse> handler)

Description copied from interface: DatabaseToolsAsync

Creates a new Database Tools private endpoint.

Specified by:

createDatabaseToolsPrivateEndpoint in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

deleteDatabaseToolsConnection

public Future<DeleteDatabaseToolsConnectionResponse> deleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request,
                                                                                   AsyncHandler<DeleteDatabaseToolsConnectionRequest,DeleteDatabaseToolsConnectionResponse> handler)

Description copied from interface: DatabaseToolsAsync

Deletes the specified Database Tools connection resource.

Specified by:

deleteDatabaseToolsConnection in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

deleteDatabaseToolsPrivateEndpoint

public Future<DeleteDatabaseToolsPrivateEndpointResponse> deleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request,
                                                                                             AsyncHandler<DeleteDatabaseToolsPrivateEndpointRequest,DeleteDatabaseToolsPrivateEndpointResponse> handler)

Description copied from interface: DatabaseToolsAsync

Deletes the specified Database Tools private endpoint.

Specified by:

deleteDatabaseToolsPrivateEndpoint in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

getDatabaseToolsConnection

public Future<GetDatabaseToolsConnectionResponse> getDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request,
                                                                             AsyncHandler<GetDatabaseToolsConnectionRequest,GetDatabaseToolsConnectionResponse> handler)

Description copied from interface: DatabaseToolsAsync

Gets details of the specified Database Tools connection.

Specified by:

getDatabaseToolsConnection in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

getDatabaseToolsEndpointService

public Future<GetDatabaseToolsEndpointServiceResponse> getDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request,
                                                                                       AsyncHandler<GetDatabaseToolsEndpointServiceRequest,GetDatabaseToolsEndpointServiceResponse> handler)

Description copied from interface: DatabaseToolsAsync

Gets details for the specified Database Tools endpoint service.

Specified by:

getDatabaseToolsEndpointService in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

getDatabaseToolsPrivateEndpoint

public Future<GetDatabaseToolsPrivateEndpointResponse> getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request,
                                                                                       AsyncHandler<GetDatabaseToolsPrivateEndpointRequest,GetDatabaseToolsPrivateEndpointResponse> handler)

Description copied from interface: DatabaseToolsAsync

Gets details of a specified Database Tools private endpoint.

Specified by:

getDatabaseToolsPrivateEndpoint in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: DatabaseToolsAsync

Gets the status of the specified work request.

Specified by:

getWorkRequest in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listDatabaseToolsConnections

public Future<ListDatabaseToolsConnectionsResponse> listDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request,
                                                                                 AsyncHandler<ListDatabaseToolsConnectionsRequest,ListDatabaseToolsConnectionsResponse> handler)

Description copied from interface: DatabaseToolsAsync

Returns a list of Database Tools connections.

Specified by:

listDatabaseToolsConnections in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listDatabaseToolsEndpointServices

public Future<ListDatabaseToolsEndpointServicesResponse> listDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request,
                                                                                           AsyncHandler<ListDatabaseToolsEndpointServicesRequest,ListDatabaseToolsEndpointServicesResponse> handler)

Description copied from interface: DatabaseToolsAsync

Returns a list of Database Tools endpoint services.

Specified by:

listDatabaseToolsEndpointServices in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listDatabaseToolsPrivateEndpoints

public Future<ListDatabaseToolsPrivateEndpointsResponse> listDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request,
                                                                                           AsyncHandler<ListDatabaseToolsPrivateEndpointsRequest,ListDatabaseToolsPrivateEndpointsResponse> handler)

Description copied from interface: DatabaseToolsAsync

Returns a list of Database Tools private endpoints.

Specified by:

listDatabaseToolsPrivateEndpoints in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: DatabaseToolsAsync

Returns a paginated list of errors for the specified work request.

Specified by:

listWorkRequestErrors in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: DatabaseToolsAsync

Returns a paginated list of logs for the specified work request.

Specified by:

listWorkRequestLogs in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: DatabaseToolsAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

removeDatabaseToolsConnectionLock

public Future<RemoveDatabaseToolsConnectionLockResponse> removeDatabaseToolsConnectionLock(RemoveDatabaseToolsConnectionLockRequest request,
                                                                                           AsyncHandler<RemoveDatabaseToolsConnectionLockRequest,RemoveDatabaseToolsConnectionLockResponse> handler)

Description copied from interface: DatabaseToolsAsync

Removes a lock from a DatabaseToolsConnection resource.

Specified by:

removeDatabaseToolsConnectionLock in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

removeDatabaseToolsPrivateEndpointLock

public Future<RemoveDatabaseToolsPrivateEndpointLockResponse> removeDatabaseToolsPrivateEndpointLock(RemoveDatabaseToolsPrivateEndpointLockRequest request,
                                                                                                     AsyncHandler<RemoveDatabaseToolsPrivateEndpointLockRequest,RemoveDatabaseToolsPrivateEndpointLockResponse> handler)

Description copied from interface: DatabaseToolsAsync

Removes a lock from a DatabaseToolsPrivateEndpoint resource.

Specified by:

removeDatabaseToolsPrivateEndpointLock in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

updateDatabaseToolsConnection

public Future<UpdateDatabaseToolsConnectionResponse> updateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request,
                                                                                   AsyncHandler<UpdateDatabaseToolsConnectionRequest,UpdateDatabaseToolsConnectionResponse> handler)

Description copied from interface: DatabaseToolsAsync

Updates the specified Database Tools connection.

Specified by:

updateDatabaseToolsConnection in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

updateDatabaseToolsPrivateEndpoint

public Future<UpdateDatabaseToolsPrivateEndpointResponse> updateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request,
                                                                                             AsyncHandler<UpdateDatabaseToolsPrivateEndpointRequest,UpdateDatabaseToolsPrivateEndpointResponse> handler)

Description copied from interface: DatabaseToolsAsync

Updates the specified Database Tools private endpoint.

Specified by:

updateDatabaseToolsPrivateEndpoint in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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.

validateDatabaseToolsConnection

public Future<ValidateDatabaseToolsConnectionResponse> validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request,
                                                                                       AsyncHandler<ValidateDatabaseToolsConnectionRequest,ValidateDatabaseToolsConnectionResponse> handler)

Description copied from interface: DatabaseToolsAsync

Validates the Database Tools connection details by establishing a connection to the database.

Specified by:

validateDatabaseToolsConnection in interface DatabaseToolsAsync

Parameters:

request - The request object containing the details to send

handler - 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()

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

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

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)