java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.databasetools.DatabaseToolsClient

All Implemented Interfaces:: DatabaseTools, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201005")
public class DatabaseToolsClient
extends BaseSyncClient
implements DatabaseTools

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DatabaseToolsClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	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	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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AddDatabaseToolsConnectionLockResponse`	`addDatabaseToolsConnectionLock(AddDatabaseToolsConnectionLockRequest request)`	Adds a lock to a DatabaseToolsConnection resource.
`AddDatabaseToolsIdentityLockResponse`	`addDatabaseToolsIdentityLock(AddDatabaseToolsIdentityLockRequest request)`	Adds a lock to a DatabaseToolsIdentity resource.
`AddDatabaseToolsPrivateEndpointLockResponse`	`addDatabaseToolsPrivateEndpointLock(AddDatabaseToolsPrivateEndpointLockRequest request)`	Adds a lock to a DatabaseToolsPrivateEndpoint resource.
`static DatabaseToolsClient.Builder`	`builder()`	Create a builder for this client.
`ChangeDatabaseToolsConnectionCompartmentResponse`	`changeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest request)`	Moves the specified Database Tools connection to a different compartment in the same tenancy.
`ChangeDatabaseToolsIdentityCompartmentResponse`	`changeDatabaseToolsIdentityCompartment(ChangeDatabaseToolsIdentityCompartmentRequest request)`	Moves the specified Database Tools identity to a different compartment in the same tenancy.
`ChangeDatabaseToolsPrivateEndpointCompartmentResponse`	`changeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request)`	Moves a Database Tools private endpoint into a different compartment in the same tenancy.
`void`	`close()`
`CreateDatabaseToolsConnectionResponse`	`createDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request)`	Creates a new Database Tools connection.
`CreateDatabaseToolsIdentityResponse`	`createDatabaseToolsIdentity(CreateDatabaseToolsIdentityRequest request)`	Creates a new Database Tools identity.
`CreateDatabaseToolsPrivateEndpointResponse`	`createDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request)`	Creates a new Database Tools private endpoint.
`DeleteDatabaseToolsConnectionResponse`	`deleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request)`	Deletes the specified Database Tools connection resource.
`DeleteDatabaseToolsIdentityResponse`	`deleteDatabaseToolsIdentity(DeleteDatabaseToolsIdentityRequest request)`	Deletes the specified Database Tools identity resource.
`DeleteDatabaseToolsPrivateEndpointResponse`	`deleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request)`	Deletes the specified Database Tools private endpoint.
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`String`	`getClientCommonLibraryVersion()`
`GetDatabaseToolsConnectionResponse`	`getDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request)`	Gets details of the specified Database Tools connection.
`GetDatabaseToolsEndpointServiceResponse`	`getDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request)`	Gets details for the specified Database Tools endpoint service.
`GetDatabaseToolsIdentityResponse`	`getDatabaseToolsIdentity(GetDatabaseToolsIdentityRequest request)`	Gets details of the specified Database Tools identity.
`GetDatabaseToolsPrivateEndpointResponse`	`getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request)`	Gets details of a specified Database Tools private endpoint.
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`	Get the endpoint of the client.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Map<String,Boolean>`	`getOptionsMap()`	Return an immutable snapshot representing the current options set for this client.
`DatabaseToolsPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`String`	`getResolvedEndpoint(Map<String,Object> requiredParametersMap)`	Returns the endpoint after filling in the current options, as determined by `BaseClient.getOptionsMap()`, and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
`DatabaseToolsWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)`	Gets the status of the specified work request.
`ListDatabaseToolsConnectionsResponse`	`listDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request)`	Returns a list of Database Tools connections.
`ListDatabaseToolsEndpointServicesResponse`	`listDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request)`	Returns a list of Database Tools endpoint services.
`ListDatabaseToolsIdentitiesResponse`	`listDatabaseToolsIdentities(ListDatabaseToolsIdentitiesRequest request)`	Returns a list of Database Tools identities.
`ListDatabaseToolsPrivateEndpointsResponse`	`listDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request)`	Returns a list of Database Tools private endpoints.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)`	Returns a paginated list of errors for the specified work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)`	Returns a paginated list of logs for the specified work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)`	Lists the work requests in a compartment.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`RefreshDatabaseToolsIdentityCredentialResponse`	`refreshDatabaseToolsIdentityCredential(RefreshDatabaseToolsIdentityCredentialRequest request)`	Refresh Database Tools identity credential.
`RemoveDatabaseToolsConnectionLockResponse`	`removeDatabaseToolsConnectionLock(RemoveDatabaseToolsConnectionLockRequest request)`	Removes a lock from a DatabaseToolsConnection resource.
`RemoveDatabaseToolsIdentityLockResponse`	`removeDatabaseToolsIdentityLock(RemoveDatabaseToolsIdentityLockRequest request)`	Removes a lock from a DatabaseToolsIdentity resource.
`RemoveDatabaseToolsPrivateEndpointLockResponse`	`removeDatabaseToolsPrivateEndpointLock(RemoveDatabaseToolsPrivateEndpointLockRequest request)`	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’).
`UpdateDatabaseToolsConnectionResponse`	`updateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request)`	Updates the specified Database Tools connection.
`UpdateDatabaseToolsIdentityResponse`	`updateDatabaseToolsIdentity(UpdateDatabaseToolsIdentityRequest request)`	Updates the specified Database Tools identity.
`UpdateDatabaseToolsPrivateEndpointResponse`	`updateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request)`	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.
`ValidateDatabaseToolsConnectionResponse`	`validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request)`	Validates the Database Tools connection details by establishing a connection to the database.
`ValidateDatabaseToolsIdentityCredentialResponse`	`validateDatabaseToolsIdentityCredential(ValidateDatabaseToolsIdentityCredentialRequest request)`	Validates the Database Tools identity credentials by establishing a connection to the customer database and executing the dbms_cloud.send_request to validate the credential.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.databasetools.DatabaseTools
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- 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
  - DatabaseToolsClient
```
@Deprecated
public DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see DatabaseToolsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - DatabaseToolsClient
```
@Deprecated
public DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see DatabaseToolsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - DatabaseToolsClient
```
@Deprecated
public DatabaseToolsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see DatabaseToolsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - DatabaseToolsClient
```
@Deprecated
public DatabaseToolsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    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
  - DatabaseToolsClient
```
@Deprecated
public DatabaseToolsClient(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 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
  - DatabaseToolsClient
```
@Deprecated
public DatabaseToolsClient(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 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)
  - DatabaseToolsClient
```
@Deprecated
public DatabaseToolsClient(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 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
  - DatabaseToolsClient
```
@Deprecated
public 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.
    
    Create a new client instance.
    
    Parameters:
    
    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
- Method Detail
  - builder
```
public static DatabaseToolsClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setRegion in interface DatabaseTools
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setRegion in interface DatabaseTools
    
    Parameters:
    
    regionId - The public region ID.
  - addDatabaseToolsConnectionLock
```
public AddDatabaseToolsConnectionLockResponse addDatabaseToolsConnectionLock(AddDatabaseToolsConnectionLockRequest request)
```
    Description copied from interface: DatabaseTools
    
    Adds a lock to a DatabaseToolsConnection resource.
    
    Specified by:
    
    addDatabaseToolsConnectionLock in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - addDatabaseToolsIdentityLock
```
public AddDatabaseToolsIdentityLockResponse addDatabaseToolsIdentityLock(AddDatabaseToolsIdentityLockRequest request)
```
    Description copied from interface: DatabaseTools
    
    Adds a lock to a DatabaseToolsIdentity resource.
    
    Specified by:
    
    addDatabaseToolsIdentityLock in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - addDatabaseToolsPrivateEndpointLock
```
public AddDatabaseToolsPrivateEndpointLockResponse addDatabaseToolsPrivateEndpointLock(AddDatabaseToolsPrivateEndpointLockRequest request)
```
    Description copied from interface: DatabaseTools
    
    Adds a lock to a DatabaseToolsPrivateEndpoint resource.
    
    Specified by:
    
    addDatabaseToolsPrivateEndpointLock in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeDatabaseToolsConnectionCompartment
```
public ChangeDatabaseToolsConnectionCompartmentResponse changeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    changeDatabaseToolsConnectionCompartment in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeDatabaseToolsIdentityCompartment
```
public ChangeDatabaseToolsIdentityCompartmentResponse changeDatabaseToolsIdentityCompartment(ChangeDatabaseToolsIdentityCompartmentRequest request)
```
    Description copied from interface: DatabaseTools
    
    Moves the specified Database Tools identity to a different compartment in the same tenancy.
    For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Specified by:
    
    changeDatabaseToolsIdentityCompartment in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeDatabaseToolsPrivateEndpointCompartment
```
public ChangeDatabaseToolsPrivateEndpointCompartmentResponse changeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    changeDatabaseToolsPrivateEndpointCompartment in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDatabaseToolsConnection
```
public CreateDatabaseToolsConnectionResponse createDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request)
```
    Description copied from interface: DatabaseTools
    
    Creates a new Database Tools connection.
    
    Specified by:
    
    createDatabaseToolsConnection in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDatabaseToolsIdentity
```
public CreateDatabaseToolsIdentityResponse createDatabaseToolsIdentity(CreateDatabaseToolsIdentityRequest request)
```
    Description copied from interface: DatabaseTools
    
    Creates a new Database Tools identity.
    
    Specified by:
    
    createDatabaseToolsIdentity in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDatabaseToolsPrivateEndpoint
```
public CreateDatabaseToolsPrivateEndpointResponse createDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request)
```
    Description copied from interface: DatabaseTools
    
    Creates a new Database Tools private endpoint.
    
    Specified by:
    
    createDatabaseToolsPrivateEndpoint in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDatabaseToolsConnection
```
public DeleteDatabaseToolsConnectionResponse deleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request)
```
    Description copied from interface: DatabaseTools
    
    Deletes the specified Database Tools connection resource.
    
    Specified by:
    
    deleteDatabaseToolsConnection in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDatabaseToolsIdentity
```
public DeleteDatabaseToolsIdentityResponse deleteDatabaseToolsIdentity(DeleteDatabaseToolsIdentityRequest request)
```
    Description copied from interface: DatabaseTools
    
    Deletes the specified Database Tools identity resource.
    
    Specified by:
    
    deleteDatabaseToolsIdentity in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDatabaseToolsPrivateEndpoint
```
public DeleteDatabaseToolsPrivateEndpointResponse deleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request)
```
    Description copied from interface: DatabaseTools
    
    Deletes the specified Database Tools private endpoint.
    
    Specified by:
    
    deleteDatabaseToolsPrivateEndpoint in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDatabaseToolsConnection
```
public GetDatabaseToolsConnectionResponse getDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request)
```
    Description copied from interface: DatabaseTools
    
    Gets details of the specified Database Tools connection.
    
    Specified by:
    
    getDatabaseToolsConnection in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDatabaseToolsEndpointService
```
public GetDatabaseToolsEndpointServiceResponse getDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request)
```
    Description copied from interface: DatabaseTools
    
    Gets details for the specified Database Tools endpoint service.
    
    Specified by:
    
    getDatabaseToolsEndpointService in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDatabaseToolsIdentity
```
public GetDatabaseToolsIdentityResponse getDatabaseToolsIdentity(GetDatabaseToolsIdentityRequest request)
```
    Description copied from interface: DatabaseTools
    
    Gets details of the specified Database Tools identity.
    
    Specified by:
    
    getDatabaseToolsIdentity in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDatabaseToolsPrivateEndpoint
```
public GetDatabaseToolsPrivateEndpointResponse getDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request)
```
    Description copied from interface: DatabaseTools
    
    Gets details of a specified Database Tools private endpoint.
    
    Specified by:
    
    getDatabaseToolsPrivateEndpoint in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: DatabaseTools
    
    Gets the status of the specified work request.
    
    Specified by:
    
    getWorkRequest in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDatabaseToolsConnections
```
public ListDatabaseToolsConnectionsResponse listDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request)
```
    Description copied from interface: DatabaseTools
    
    Returns a list of Database Tools connections.
    
    Specified by:
    
    listDatabaseToolsConnections in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDatabaseToolsEndpointServices
```
public ListDatabaseToolsEndpointServicesResponse listDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request)
```
    Description copied from interface: DatabaseTools
    
    Returns a list of Database Tools endpoint services.
    
    Specified by:
    
    listDatabaseToolsEndpointServices in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDatabaseToolsIdentities
```
public ListDatabaseToolsIdentitiesResponse listDatabaseToolsIdentities(ListDatabaseToolsIdentitiesRequest request)
```
    Description copied from interface: DatabaseTools
    
    Returns a list of Database Tools identities.
    
    Specified by:
    
    listDatabaseToolsIdentities in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDatabaseToolsPrivateEndpoints
```
public ListDatabaseToolsPrivateEndpointsResponse listDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request)
```
    Description copied from interface: DatabaseTools
    
    Returns a list of Database Tools private endpoints.
    
    Specified by:
    
    listDatabaseToolsPrivateEndpoints in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: DatabaseTools
    
    Returns a paginated list of errors for the specified work request.
    
    Specified by:
    
    listWorkRequestErrors in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: DatabaseTools
    
    Returns a paginated list of logs for the specified work request.
    
    Specified by:
    
    listWorkRequestLogs in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: DatabaseTools
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - refreshDatabaseToolsIdentityCredential
```
public RefreshDatabaseToolsIdentityCredentialResponse refreshDatabaseToolsIdentityCredential(RefreshDatabaseToolsIdentityCredentialRequest request)
```
    Description copied from interface: DatabaseTools
    
    Refresh Database Tools identity credential.
    
    Specified by:
    
    refreshDatabaseToolsIdentityCredential in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeDatabaseToolsConnectionLock
```
public RemoveDatabaseToolsConnectionLockResponse removeDatabaseToolsConnectionLock(RemoveDatabaseToolsConnectionLockRequest request)
```
    Description copied from interface: DatabaseTools
    
    Removes a lock from a DatabaseToolsConnection resource.
    
    Specified by:
    
    removeDatabaseToolsConnectionLock in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeDatabaseToolsIdentityLock
```
public RemoveDatabaseToolsIdentityLockResponse removeDatabaseToolsIdentityLock(RemoveDatabaseToolsIdentityLockRequest request)
```
    Description copied from interface: DatabaseTools
    
    Removes a lock from a DatabaseToolsIdentity resource.
    
    Specified by:
    
    removeDatabaseToolsIdentityLock in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeDatabaseToolsPrivateEndpointLock
```
public RemoveDatabaseToolsPrivateEndpointLockResponse removeDatabaseToolsPrivateEndpointLock(RemoveDatabaseToolsPrivateEndpointLockRequest request)
```
    Description copied from interface: DatabaseTools
    
    Removes a lock from a DatabaseToolsPrivateEndpoint resource.
    
    Specified by:
    
    removeDatabaseToolsPrivateEndpointLock in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDatabaseToolsConnection
```
public UpdateDatabaseToolsConnectionResponse updateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request)
```
    Description copied from interface: DatabaseTools
    
    Updates the specified Database Tools connection.
    
    Specified by:
    
    updateDatabaseToolsConnection in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDatabaseToolsIdentity
```
public UpdateDatabaseToolsIdentityResponse updateDatabaseToolsIdentity(UpdateDatabaseToolsIdentityRequest request)
```
    Description copied from interface: DatabaseTools
    
    Updates the specified Database Tools identity.
    
    Specified by:
    
    updateDatabaseToolsIdentity in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDatabaseToolsPrivateEndpoint
```
public UpdateDatabaseToolsPrivateEndpointResponse updateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request)
```
    Description copied from interface: DatabaseTools
    
    Updates the specified Database Tools private endpoint.
    
    Specified by:
    
    updateDatabaseToolsPrivateEndpoint in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - validateDatabaseToolsConnection
```
public ValidateDatabaseToolsConnectionResponse validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request)
```
    Description copied from interface: DatabaseTools
    
    Validates the Database Tools connection details by establishing a connection to the database.
    
    Specified by:
    
    validateDatabaseToolsConnection in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - validateDatabaseToolsIdentityCredential
```
public ValidateDatabaseToolsIdentityCredentialResponse validateDatabaseToolsIdentityCredential(ValidateDatabaseToolsIdentityCredentialRequest request)
```
    Description copied from interface: DatabaseTools
    
    Validates the Database Tools identity credentials by establishing a connection to the customer database and executing the dbms_cloud.send_request to validate the credential.
    
    Specified by:
    
    validateDatabaseToolsIdentityCredential in interface DatabaseTools
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public DatabaseToolsWaiters getWaiters()
```
    Description copied from interface: DatabaseTools
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface DatabaseTools
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public DatabaseToolsPaginators getPaginators()
```
    Description copied from interface: 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.
    
    Specified by:
    
    getPaginators in interface DatabaseTools
    
    Returns:
    
    The service paginators.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - enableDualStackEndpoints
```
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
```
    This method should be used to enable or disable the use of dual-stack endpoints.
    The default value is false i.e. dual-stack endpoints are disabled by default.
    
    Parameters:
    
    enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
  - getOptionsMap
```
public Map<String,Boolean> getOptionsMap()
```
    Return an immutable snapshot representing the current options set for this client.
    
    Returns:
    
    immutable snapshot representing the current options set for this client
  - getResolvedEndpoint
```
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
```
    Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
    
    Parameters:
    
    requiredParametersMap - the map from required parameter name to their values
    
    Returns:
    
    resolved endpoint, with all options and placeholders filled in
  - 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
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
    Get the endpoint of the client.
    Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.
    Examples of endpoints this may return:
    
    Unparameterized endpoints
    https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with placeholders
    https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with options
    https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
    
    Parameterized endpoints with placeholders and options
    https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).
    Returns:
    
    the endpoint being used by the client
  - 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()
```

Class DatabaseToolsClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

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

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

DatabaseToolsClient

DatabaseToolsClient

DatabaseToolsClient

DatabaseToolsClient

DatabaseToolsClient

DatabaseToolsClient

DatabaseToolsClient

DatabaseToolsClient

Method Detail

builder

setRegion

setRegion

addDatabaseToolsConnectionLock

addDatabaseToolsIdentityLock

addDatabaseToolsPrivateEndpointLock

changeDatabaseToolsConnectionCompartment

changeDatabaseToolsIdentityCompartment

changeDatabaseToolsPrivateEndpointCompartment

createDatabaseToolsConnection

createDatabaseToolsIdentity

createDatabaseToolsPrivateEndpoint

deleteDatabaseToolsConnection

deleteDatabaseToolsIdentity

deleteDatabaseToolsPrivateEndpoint

getDatabaseToolsConnection

getDatabaseToolsEndpointService

getDatabaseToolsIdentity

getDatabaseToolsPrivateEndpoint

getWorkRequest

listDatabaseToolsConnections

listDatabaseToolsEndpointServices

listDatabaseToolsIdentities

listDatabaseToolsPrivateEndpoints

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

refreshDatabaseToolsIdentityCredential

removeDatabaseToolsConnectionLock

removeDatabaseToolsIdentityLock

removeDatabaseToolsPrivateEndpointLock

updateDatabaseToolsConnection

updateDatabaseToolsIdentity

updateDatabaseToolsPrivateEndpoint

validateDatabaseToolsConnection

validateDatabaseToolsIdentityCredential

getWaiters

getPaginators

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient