Interface DatabaseToolsAsync
- 
- All Superinterfaces:
- AutoCloseable
 - All Known Implementing Classes:
- DatabaseToolsAsyncClient
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20201005") public interface DatabaseToolsAsync extends AutoCloseableUse the Database Tools API to manage connections, private endpoints, and work requests in the Database Tools service.
- 
- 
Method Summary- 
Methods inherited from interface java.lang.AutoCloseableclose
 
- 
 
- 
- 
- 
Method Detail- 
refreshClientvoid refreshClient() Rebuilds the client from scratch.Useful to refresh certificates. 
 - 
setEndpointvoid setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).- Parameters:
- endpoint- The endpoint of the serice.
 
 - 
getEndpointString getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
 - 
setRegionvoid setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Parameters:
- region- The region of the service.
 
 - 
setRegionvoid setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format ( Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Parameters:
- regionId- The public region ID.
 
 - 
useRealmSpecificEndpointTemplatevoid useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false” - Parameters:
- realmSpecificEndpointTemplateEnabled- flag to enable the use of realm specific endpoint template
 
 - 
addDatabaseToolsConnectionLockFuture<AddDatabaseToolsConnectionLockResponse> addDatabaseToolsConnectionLock(AddDatabaseToolsConnectionLockRequest request, AsyncHandler<AddDatabaseToolsConnectionLockRequest,AddDatabaseToolsConnectionLockResponse> handler) Adds a lock to a DatabaseToolsConnection resource.- 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.
 
 - 
addDatabaseToolsPrivateEndpointLockFuture<AddDatabaseToolsPrivateEndpointLockResponse> addDatabaseToolsPrivateEndpointLock(AddDatabaseToolsPrivateEndpointLockRequest request, AsyncHandler<AddDatabaseToolsPrivateEndpointLockRequest,AddDatabaseToolsPrivateEndpointLockResponse> handler) Adds a lock to a DatabaseToolsPrivateEndpoint resource.- 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.
 
 - 
changeDatabaseToolsConnectionCompartmentFuture<ChangeDatabaseToolsConnectionCompartmentResponse> changeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest request, AsyncHandler<ChangeDatabaseToolsConnectionCompartmentRequest,ChangeDatabaseToolsConnectionCompartmentResponse> handler) 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. - 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.
 
 - 
changeDatabaseToolsPrivateEndpointCompartmentFuture<ChangeDatabaseToolsPrivateEndpointCompartmentResponse> changeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request, AsyncHandler<ChangeDatabaseToolsPrivateEndpointCompartmentRequest,ChangeDatabaseToolsPrivateEndpointCompartmentResponse> handler) 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. - 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.
 
 - 
createDatabaseToolsConnectionFuture<CreateDatabaseToolsConnectionResponse> createDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request, AsyncHandler<CreateDatabaseToolsConnectionRequest,CreateDatabaseToolsConnectionResponse> handler) Creates a new Database Tools connection.- 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.
 
 - 
createDatabaseToolsPrivateEndpointFuture<CreateDatabaseToolsPrivateEndpointResponse> createDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request, AsyncHandler<CreateDatabaseToolsPrivateEndpointRequest,CreateDatabaseToolsPrivateEndpointResponse> handler) Creates a new Database Tools private endpoint.- 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.
 
 - 
deleteDatabaseToolsConnectionFuture<DeleteDatabaseToolsConnectionResponse> deleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request, AsyncHandler<DeleteDatabaseToolsConnectionRequest,DeleteDatabaseToolsConnectionResponse> handler) Deletes the specified Database Tools connection resource.- 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.
 
 - 
deleteDatabaseToolsPrivateEndpointFuture<DeleteDatabaseToolsPrivateEndpointResponse> deleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request, AsyncHandler<DeleteDatabaseToolsPrivateEndpointRequest,DeleteDatabaseToolsPrivateEndpointResponse> handler) Deletes the specified Database Tools private endpoint.- 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.
 
 - 
getDatabaseToolsConnectionFuture<GetDatabaseToolsConnectionResponse> getDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request, AsyncHandler<GetDatabaseToolsConnectionRequest,GetDatabaseToolsConnectionResponse> handler) Gets details of the specified Database Tools connection.- 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.
 
 - 
getDatabaseToolsEndpointServiceFuture<GetDatabaseToolsEndpointServiceResponse> getDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request, AsyncHandler<GetDatabaseToolsEndpointServiceRequest,GetDatabaseToolsEndpointServiceResponse> handler) Gets details for the specified Database Tools endpoint service.- 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.
 
 - 
getDatabaseToolsPrivateEndpointFuture<GetDatabaseToolsPrivateEndpointResponse> getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request, AsyncHandler<GetDatabaseToolsPrivateEndpointRequest,GetDatabaseToolsPrivateEndpointResponse> handler) Gets details of a specified Database Tools private endpoint.- 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.
 
 - 
getWorkRequestFuture<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the specified work request.- 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.
 
 - 
listDatabaseToolsConnectionsFuture<ListDatabaseToolsConnectionsResponse> listDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request, AsyncHandler<ListDatabaseToolsConnectionsRequest,ListDatabaseToolsConnectionsResponse> handler) Returns a list of Database Tools connections.- 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.
 
 - 
listDatabaseToolsEndpointServicesFuture<ListDatabaseToolsEndpointServicesResponse> listDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request, AsyncHandler<ListDatabaseToolsEndpointServicesRequest,ListDatabaseToolsEndpointServicesResponse> handler) Returns a list of Database Tools endpoint services.- 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.
 
 - 
listDatabaseToolsPrivateEndpointsFuture<ListDatabaseToolsPrivateEndpointsResponse> listDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request, AsyncHandler<ListDatabaseToolsPrivateEndpointsRequest,ListDatabaseToolsPrivateEndpointsResponse> handler) Returns a list of Database Tools private endpoints.- 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.
 
 - 
listWorkRequestErrorsFuture<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Returns a paginated list of errors for the specified work request.- 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.
 
 - 
listWorkRequestLogsFuture<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Returns a paginated list of logs for the specified work request.- 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.
 
 - 
listWorkRequestsFuture<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a compartment.- 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.
 
 - 
removeDatabaseToolsConnectionLockFuture<RemoveDatabaseToolsConnectionLockResponse> removeDatabaseToolsConnectionLock(RemoveDatabaseToolsConnectionLockRequest request, AsyncHandler<RemoveDatabaseToolsConnectionLockRequest,RemoveDatabaseToolsConnectionLockResponse> handler) Removes a lock from a DatabaseToolsConnection resource.- 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.
 
 - 
removeDatabaseToolsPrivateEndpointLockFuture<RemoveDatabaseToolsPrivateEndpointLockResponse> removeDatabaseToolsPrivateEndpointLock(RemoveDatabaseToolsPrivateEndpointLockRequest request, AsyncHandler<RemoveDatabaseToolsPrivateEndpointLockRequest,RemoveDatabaseToolsPrivateEndpointLockResponse> handler) Removes a lock from a DatabaseToolsPrivateEndpoint resource.- 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.
 
 - 
updateDatabaseToolsConnectionFuture<UpdateDatabaseToolsConnectionResponse> updateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request, AsyncHandler<UpdateDatabaseToolsConnectionRequest,UpdateDatabaseToolsConnectionResponse> handler) Updates the specified Database Tools connection.- 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.
 
 - 
updateDatabaseToolsPrivateEndpointFuture<UpdateDatabaseToolsPrivateEndpointResponse> updateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request, AsyncHandler<UpdateDatabaseToolsPrivateEndpointRequest,UpdateDatabaseToolsPrivateEndpointResponse> handler) Updates the specified Database Tools private endpoint.- 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.
 
 - 
validateDatabaseToolsConnectionFuture<ValidateDatabaseToolsConnectionResponse> validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request, AsyncHandler<ValidateDatabaseToolsConnectionRequest,ValidateDatabaseToolsConnectionResponse> handler) Validates the Database Tools connection details by establishing a connection to the database.- 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.
 
 
- 
 
-