@Generated(value="OracleSDKGenerator", comments="API Version: 20201005") public class DatabaseToolsClient extends BaseSyncClient implements DatabaseTools
Modifier and Type | Class and Description |
---|---|
static class |
DatabaseToolsClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for DatabaseTools.
|
Constructor and Description |
---|
DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint
close
public static final Service SERVICE
Service instance for DatabaseTools.
@Deprecated public DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseToolsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseToolsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseToolsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseToolsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseToolsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseToolsClient.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)
@Deprecated public DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseToolsClient.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
@Deprecated public DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseToolsClient.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
executorService
- DatabaseToolsClient.Builder.executorService
public static DatabaseToolsClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
DatabaseTools
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 DatabaseTools
region
- The region of the service.public void setRegion(String regionId)
DatabaseTools
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 DatabaseTools
regionId
- The public region ID.public ChangeDatabaseToolsConnectionCompartmentResponse changeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest request)
DatabaseTools
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 DatabaseTools
request
- The request object containing the details to sendpublic ChangeDatabaseToolsPrivateEndpointCompartmentResponse changeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request)
DatabaseTools
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 DatabaseTools
request
- The request object containing the details to sendpublic CreateDatabaseToolsConnectionResponse createDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request)
DatabaseTools
Creates a new Database Tools connection.
createDatabaseToolsConnection
in interface DatabaseTools
request
- The request object containing the details to sendpublic CreateDatabaseToolsPrivateEndpointResponse createDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request)
DatabaseTools
Creates a new Database Tools private endpoint.
createDatabaseToolsPrivateEndpoint
in interface DatabaseTools
request
- The request object containing the details to sendpublic DeleteDatabaseToolsConnectionResponse deleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request)
DatabaseTools
Deletes the specified Database Tools connection resource.
deleteDatabaseToolsConnection
in interface DatabaseTools
request
- The request object containing the details to sendpublic DeleteDatabaseToolsPrivateEndpointResponse deleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request)
DatabaseTools
Deletes the specified Database Tools private endpoint.
deleteDatabaseToolsPrivateEndpoint
in interface DatabaseTools
request
- The request object containing the details to sendpublic GetDatabaseToolsConnectionResponse getDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request)
DatabaseTools
Gets details of the specified Database Tools connection.
getDatabaseToolsConnection
in interface DatabaseTools
request
- The request object containing the details to sendpublic GetDatabaseToolsEndpointServiceResponse getDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request)
DatabaseTools
Gets details for the specified Database Tools endpoint service.
getDatabaseToolsEndpointService
in interface DatabaseTools
request
- The request object containing the details to sendpublic GetDatabaseToolsPrivateEndpointResponse getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request)
DatabaseTools
Gets details of a specified Database Tools private endpoint.
getDatabaseToolsPrivateEndpoint
in interface DatabaseTools
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
DatabaseTools
Gets the status of the specified work request.
getWorkRequest
in interface DatabaseTools
request
- The request object containing the details to sendpublic ListDatabaseToolsConnectionsResponse listDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request)
DatabaseTools
Returns a list of Database Tools connections.
listDatabaseToolsConnections
in interface DatabaseTools
request
- The request object containing the details to sendpublic ListDatabaseToolsEndpointServicesResponse listDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request)
DatabaseTools
Returns a list of Database Tools endpoint services.
listDatabaseToolsEndpointServices
in interface DatabaseTools
request
- The request object containing the details to sendpublic ListDatabaseToolsPrivateEndpointsResponse listDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request)
DatabaseTools
Returns a list of Database Tools private endpoints.
listDatabaseToolsPrivateEndpoints
in interface DatabaseTools
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
DatabaseTools
Returns a paginated list of errors for the specified work request.
listWorkRequestErrors
in interface DatabaseTools
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
DatabaseTools
Returns a paginated list of logs for the specified work request.
listWorkRequestLogs
in interface DatabaseTools
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
DatabaseTools
Lists the work requests in a compartment.
listWorkRequests
in interface DatabaseTools
request
- The request object containing the details to sendpublic UpdateDatabaseToolsConnectionResponse updateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request)
DatabaseTools
Updates the specified Database Tools connection.
updateDatabaseToolsConnection
in interface DatabaseTools
request
- The request object containing the details to sendpublic UpdateDatabaseToolsPrivateEndpointResponse updateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request)
DatabaseTools
Updates the specified Database Tools private endpoint.
updateDatabaseToolsPrivateEndpoint
in interface DatabaseTools
request
- The request object containing the details to sendpublic ValidateDatabaseToolsConnectionResponse validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request)
DatabaseTools
Validates the Database Tools connection details by establishing a connection to the database.
validateDatabaseToolsConnection
in interface DatabaseTools
request
- The request object containing the details to sendpublic DatabaseToolsWaiters getWaiters()
DatabaseTools
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface DatabaseTools
public DatabaseToolsPaginators getPaginators()
DatabaseTools
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
getPaginators
in interface DatabaseTools
protected ClientConfigurator getDefaultConfigurator()
public final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
Copyright © 2016–2023. All rights reserved.