Package com.oracle.bmc.databasetools

Interface DatabaseTools

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DatabaseToolsClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20201005")
public interface DatabaseTools
extends AutoCloseable
    Use the Database Tools API to manage connections, private endpoints, and work requests in the Database Tools service.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        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.

        Parameters:
        region - The region of the service.

      • setRegion

        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.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        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”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • addDatabaseToolsConnectionLock

        AddDatabaseToolsConnectionLockResponse addDatabaseToolsConnectionLock​(AddDatabaseToolsConnectionLockRequest request)
        Adds a lock to a DatabaseToolsConnection resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/AddDatabaseToolsConnectionLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDatabaseToolsConnectionLock API.

      • addDatabaseToolsIdentityLock

        AddDatabaseToolsIdentityLockResponse addDatabaseToolsIdentityLock​(AddDatabaseToolsIdentityLockRequest request)
        Adds a lock to a DatabaseToolsIdentity resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/AddDatabaseToolsIdentityLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDatabaseToolsIdentityLock API.

      • addDatabaseToolsPrivateEndpointLock

        AddDatabaseToolsPrivateEndpointLockResponse addDatabaseToolsPrivateEndpointLock​(AddDatabaseToolsPrivateEndpointLockRequest request)
        Adds a lock to a DatabaseToolsPrivateEndpoint resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/AddDatabaseToolsPrivateEndpointLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDatabaseToolsPrivateEndpointLock API.

      • changeDatabaseToolsConnectionCompartment

        ChangeDatabaseToolsConnectionCompartmentResponse changeDatabaseToolsConnectionCompartment​(ChangeDatabaseToolsConnectionCompartmentRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ChangeDatabaseToolsConnectionCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDatabaseToolsConnectionCompartment API.

      • changeDatabaseToolsIdentityCompartment

        ChangeDatabaseToolsIdentityCompartmentResponse changeDatabaseToolsIdentityCompartment​(ChangeDatabaseToolsIdentityCompartmentRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ChangeDatabaseToolsIdentityCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDatabaseToolsIdentityCompartment API.

      • changeDatabaseToolsPrivateEndpointCompartment

        ChangeDatabaseToolsPrivateEndpointCompartmentResponse changeDatabaseToolsPrivateEndpointCompartment​(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ChangeDatabaseToolsPrivateEndpointCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDatabaseToolsPrivateEndpointCompartment API.

      • createDatabaseToolsConnection

        CreateDatabaseToolsConnectionResponse createDatabaseToolsConnection​(CreateDatabaseToolsConnectionRequest request)
        Creates a new Database Tools connection.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/CreateDatabaseToolsConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDatabaseToolsConnection API.

      • createDatabaseToolsIdentity

        CreateDatabaseToolsIdentityResponse createDatabaseToolsIdentity​(CreateDatabaseToolsIdentityRequest request)
        Creates a new Database Tools identity.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/CreateDatabaseToolsIdentityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDatabaseToolsIdentity API.

      • createDatabaseToolsPrivateEndpoint

        CreateDatabaseToolsPrivateEndpointResponse createDatabaseToolsPrivateEndpoint​(CreateDatabaseToolsPrivateEndpointRequest request)
        Creates a new Database Tools private endpoint.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/CreateDatabaseToolsPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDatabaseToolsPrivateEndpoint API.

      • deleteDatabaseToolsConnection

        DeleteDatabaseToolsConnectionResponse deleteDatabaseToolsConnection​(DeleteDatabaseToolsConnectionRequest request)
        Deletes the specified Database Tools connection resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/DeleteDatabaseToolsConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDatabaseToolsConnection API.

      • deleteDatabaseToolsIdentity

        DeleteDatabaseToolsIdentityResponse deleteDatabaseToolsIdentity​(DeleteDatabaseToolsIdentityRequest request)
        Deletes the specified Database Tools identity resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/DeleteDatabaseToolsIdentityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDatabaseToolsIdentity API.

      • deleteDatabaseToolsPrivateEndpoint

        DeleteDatabaseToolsPrivateEndpointResponse deleteDatabaseToolsPrivateEndpoint​(DeleteDatabaseToolsPrivateEndpointRequest request)
        Deletes the specified Database Tools private endpoint.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/DeleteDatabaseToolsPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDatabaseToolsPrivateEndpoint API.

      • getDatabaseToolsConnection

        GetDatabaseToolsConnectionResponse getDatabaseToolsConnection​(GetDatabaseToolsConnectionRequest request)
        Gets details of the specified Database Tools connection.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/GetDatabaseToolsConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsConnection API.

      • getDatabaseToolsEndpointService

        GetDatabaseToolsEndpointServiceResponse getDatabaseToolsEndpointService​(GetDatabaseToolsEndpointServiceRequest request)
        Gets details for the specified Database Tools endpoint service.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/GetDatabaseToolsEndpointServiceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsEndpointService API.

      • getDatabaseToolsIdentity

        GetDatabaseToolsIdentityResponse getDatabaseToolsIdentity​(GetDatabaseToolsIdentityRequest request)
        Gets details of the specified Database Tools identity.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/GetDatabaseToolsIdentityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsIdentity API.

      • getDatabaseToolsPrivateEndpoint

        GetDatabaseToolsPrivateEndpointResponse getDatabaseToolsPrivateEndpoint​(GetDatabaseToolsPrivateEndpointRequest request)
        Gets details of a specified Database Tools private endpoint.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/GetDatabaseToolsPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsPrivateEndpoint API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets the status of the specified work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listDatabaseToolsConnections

        ListDatabaseToolsConnectionsResponse listDatabaseToolsConnections​(ListDatabaseToolsConnectionsRequest request)
        Returns a list of Database Tools connections.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ListDatabaseToolsConnectionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseToolsConnections API.

      • listDatabaseToolsEndpointServices

        ListDatabaseToolsEndpointServicesResponse listDatabaseToolsEndpointServices​(ListDatabaseToolsEndpointServicesRequest request)
        Returns a list of Database Tools endpoint services.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ListDatabaseToolsEndpointServicesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseToolsEndpointServices API.

      • listDatabaseToolsIdentities

        ListDatabaseToolsIdentitiesResponse listDatabaseToolsIdentities​(ListDatabaseToolsIdentitiesRequest request)
        Returns a list of Database Tools identities.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ListDatabaseToolsIdentitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseToolsIdentities API.

      • listDatabaseToolsPrivateEndpoints

        ListDatabaseToolsPrivateEndpointsResponse listDatabaseToolsPrivateEndpoints​(ListDatabaseToolsPrivateEndpointsRequest request)
        Returns a list of Database Tools private endpoints.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ListDatabaseToolsPrivateEndpointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseToolsPrivateEndpoints API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Returns a paginated list of errors for the specified work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.

      • listWorkRequestLogs

        ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Returns a paginated list of logs for the specified work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • refreshDatabaseToolsIdentityCredential

        RefreshDatabaseToolsIdentityCredentialResponse refreshDatabaseToolsIdentityCredential​(RefreshDatabaseToolsIdentityCredentialRequest request)
        Refresh Database Tools identity credential.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/RefreshDatabaseToolsIdentityCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RefreshDatabaseToolsIdentityCredential API.

      • removeDatabaseToolsConnectionLock

        RemoveDatabaseToolsConnectionLockResponse removeDatabaseToolsConnectionLock​(RemoveDatabaseToolsConnectionLockRequest request)
        Removes a lock from a DatabaseToolsConnection resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/RemoveDatabaseToolsConnectionLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveDatabaseToolsConnectionLock API.

      • removeDatabaseToolsIdentityLock

        RemoveDatabaseToolsIdentityLockResponse removeDatabaseToolsIdentityLock​(RemoveDatabaseToolsIdentityLockRequest request)
        Removes a lock from a DatabaseToolsIdentity resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/RemoveDatabaseToolsIdentityLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveDatabaseToolsIdentityLock API.

      • removeDatabaseToolsPrivateEndpointLock

        RemoveDatabaseToolsPrivateEndpointLockResponse removeDatabaseToolsPrivateEndpointLock​(RemoveDatabaseToolsPrivateEndpointLockRequest request)
        Removes a lock from a DatabaseToolsPrivateEndpoint resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/RemoveDatabaseToolsPrivateEndpointLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveDatabaseToolsPrivateEndpointLock API.

      • updateDatabaseToolsConnection

        UpdateDatabaseToolsConnectionResponse updateDatabaseToolsConnection​(UpdateDatabaseToolsConnectionRequest request)
        Updates the specified Database Tools connection.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/UpdateDatabaseToolsConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatabaseToolsConnection API.

      • updateDatabaseToolsIdentity

        UpdateDatabaseToolsIdentityResponse updateDatabaseToolsIdentity​(UpdateDatabaseToolsIdentityRequest request)
        Updates the specified Database Tools identity.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/UpdateDatabaseToolsIdentityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatabaseToolsIdentity API.

      • updateDatabaseToolsPrivateEndpoint

        UpdateDatabaseToolsPrivateEndpointResponse updateDatabaseToolsPrivateEndpoint​(UpdateDatabaseToolsPrivateEndpointRequest request)
        Updates the specified Database Tools private endpoint.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/UpdateDatabaseToolsPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatabaseToolsPrivateEndpoint API.

      • validateDatabaseToolsConnection

        ValidateDatabaseToolsConnectionResponse validateDatabaseToolsConnection​(ValidateDatabaseToolsConnectionRequest request)
        Validates the Database Tools connection details by establishing a connection to the database.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ValidateDatabaseToolsConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateDatabaseToolsConnection API.

      • validateDatabaseToolsIdentityCredential

        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.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/databasetools/ValidateDatabaseToolsIdentityCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateDatabaseToolsIdentityCredential API.

      • getWaiters

        DatabaseToolsWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        DatabaseToolsPaginators getPaginators()
        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.

        Returns:
        The service paginators.