@Generated(value="OracleSDKGenerator", comments="API Version: 20201005") public interface DatabaseToolsAsync extends AutoCloseable
Use the Database Tools API to manage connections, private endpoints, and work requests in the Database Tools service.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<AddDatabaseToolsConnectionLockResponse> addDatabaseToolsConnectionLock(AddDatabaseToolsConnectionLockRequest request, AsyncHandler<AddDatabaseToolsConnectionLockRequest,AddDatabaseToolsConnectionLockResponse> handler)
Adds a lock to a DatabaseToolsConnection resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AddDatabaseToolsPrivateEndpointLockResponse> addDatabaseToolsPrivateEndpointLock(AddDatabaseToolsPrivateEndpointLockRequest request, AsyncHandler<AddDatabaseToolsPrivateEndpointLockRequest,AddDatabaseToolsPrivateEndpointLockResponse> handler)
Adds a lock to a DatabaseToolsPrivateEndpoint resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDatabaseToolsConnectionResponse> createDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request, AsyncHandler<CreateDatabaseToolsConnectionRequest,CreateDatabaseToolsConnectionResponse> handler)
Creates a new Database Tools connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDatabaseToolsPrivateEndpointResponse> createDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request, AsyncHandler<CreateDatabaseToolsPrivateEndpointRequest,CreateDatabaseToolsPrivateEndpointResponse> handler)
Creates a new Database Tools private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDatabaseToolsConnectionResponse> deleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request, AsyncHandler<DeleteDatabaseToolsConnectionRequest,DeleteDatabaseToolsConnectionResponse> handler)
Deletes the specified Database Tools connection resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDatabaseToolsPrivateEndpointResponse> deleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request, AsyncHandler<DeleteDatabaseToolsPrivateEndpointRequest,DeleteDatabaseToolsPrivateEndpointResponse> handler)
Deletes the specified Database Tools private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDatabaseToolsConnectionResponse> getDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request, AsyncHandler<GetDatabaseToolsConnectionRequest,GetDatabaseToolsConnectionResponse> handler)
Gets details of the specified Database Tools connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDatabaseToolsEndpointServiceResponse> getDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request, AsyncHandler<GetDatabaseToolsEndpointServiceRequest,GetDatabaseToolsEndpointServiceResponse> handler)
Gets details for the specified Database Tools endpoint service.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDatabaseToolsPrivateEndpointResponse> getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request, AsyncHandler<GetDatabaseToolsPrivateEndpointRequest,GetDatabaseToolsPrivateEndpointResponse> handler)
Gets details of a specified Database Tools private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets the status of the specified work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDatabaseToolsConnectionsResponse> listDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request, AsyncHandler<ListDatabaseToolsConnectionsRequest,ListDatabaseToolsConnectionsResponse> handler)
Returns a list of Database Tools connections.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDatabaseToolsEndpointServicesResponse> listDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request, AsyncHandler<ListDatabaseToolsEndpointServicesRequest,ListDatabaseToolsEndpointServicesResponse> handler)
Returns a list of Database Tools endpoint services.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDatabaseToolsPrivateEndpointsResponse> listDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request, AsyncHandler<ListDatabaseToolsPrivateEndpointsRequest,ListDatabaseToolsPrivateEndpointsResponse> handler)
Returns a list of Database Tools private endpoints.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Returns a paginated list of errors for the specified work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Returns a paginated list of logs for the specified work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RemoveDatabaseToolsConnectionLockResponse> removeDatabaseToolsConnectionLock(RemoveDatabaseToolsConnectionLockRequest request, AsyncHandler<RemoveDatabaseToolsConnectionLockRequest,RemoveDatabaseToolsConnectionLockResponse> handler)
Removes a lock from a DatabaseToolsConnection resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RemoveDatabaseToolsPrivateEndpointLockResponse> removeDatabaseToolsPrivateEndpointLock(RemoveDatabaseToolsPrivateEndpointLockRequest request, AsyncHandler<RemoveDatabaseToolsPrivateEndpointLockRequest,RemoveDatabaseToolsPrivateEndpointLockResponse> handler)
Removes a lock from a DatabaseToolsPrivateEndpoint resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateDatabaseToolsConnectionResponse> updateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request, AsyncHandler<UpdateDatabaseToolsConnectionRequest,UpdateDatabaseToolsConnectionResponse> handler)
Updates the specified Database Tools connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateDatabaseToolsPrivateEndpointResponse> updateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request, AsyncHandler<UpdateDatabaseToolsPrivateEndpointRequest,UpdateDatabaseToolsPrivateEndpointResponse> handler)
Updates the specified Database Tools private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ValidateDatabaseToolsConnectionResponse> validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request, AsyncHandler<ValidateDatabaseToolsConnectionRequest,ValidateDatabaseToolsConnectionResponse> handler)
Validates the Database Tools connection details by establishing a connection to the database.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.