Package com.oracle.bmc.databasetoolsruntime

Interface DatabaseToolsRuntime

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DatabaseToolsRuntimeClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230222")
public interface DatabaseToolsRuntime
extends AutoCloseable
    Use the Database Tools Runtime API to connect to databases through Database Tools Connections.

    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

      • cancelWorkRequest

        CancelWorkRequestResponse cancelWorkRequest​(CancelWorkRequestRequest request)
        Attempts to cancel 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.86.2/databasetoolsruntime/CancelWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelWorkRequest API.

      • createCredential

        CreateCredentialResponse createCredential​(CreateCredentialRequest request)
        Creates a credential for the user specified by the key.
        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.86.2/databasetoolsruntime/CreateCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCredential API.

      • createCredentialExecuteGrantee

        CreateCredentialExecuteGranteeResponse createCredentialExecuteGrantee​(CreateCredentialExecuteGranteeRequest request)
        Grants the EXECUTE privilege on the credential to the user specified by the key.
        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.86.2/databasetoolsruntime/CreateCredentialExecuteGranteeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCredentialExecuteGrantee API.

      • createCredentialPublicSynonym

        CreateCredentialPublicSynonymResponse createCredentialPublicSynonym​(CreateCredentialPublicSynonymRequest request)
        Creates a public synonym for the given credentials
        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.86.2/databasetoolsruntime/CreateCredentialPublicSynonymExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCredentialPublicSynonym API.

      • createDatabaseToolsDatabaseApiGatewayConfigPool

        CreateDatabaseToolsDatabaseApiGatewayConfigPoolResponse createDatabaseToolsDatabaseApiGatewayConfigPool​(CreateDatabaseToolsDatabaseApiGatewayConfigPoolRequest request)
        Create a Database Tools database API gateway config pool 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 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.86.2/databasetoolsruntime/CreateDatabaseToolsDatabaseApiGatewayConfigPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDatabaseToolsDatabaseApiGatewayConfigPool API.

      • createDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec

        CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse createDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec​(CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest request)
        Create a Database Tools database API gateway config API spec 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 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.86.2/databasetoolsruntime/CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec API.

      • createDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec

        CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse createDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec​(CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest request)
        Create a Database Tools database API gateway config auto API spec 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 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.86.2/databasetoolsruntime/CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec API.

      • deleteCredential

        DeleteCredentialResponse deleteCredential​(DeleteCredentialRequest request)
        Delete 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 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.86.2/databasetoolsruntime/DeleteCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCredential API.

      • deleteCredentialExecuteGrantee

        DeleteCredentialExecuteGranteeResponse deleteCredentialExecuteGrantee​(DeleteCredentialExecuteGranteeRequest request)
        Delete execute grantee
        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.86.2/databasetoolsruntime/DeleteCredentialExecuteGranteeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCredentialExecuteGrantee API.

      • deleteCredentialPublicSynonym

        DeleteCredentialPublicSynonymResponse deleteCredentialPublicSynonym​(DeleteCredentialPublicSynonymRequest request)
        Deletes the public synonym
        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.86.2/databasetoolsruntime/DeleteCredentialPublicSynonymExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCredentialPublicSynonym API.

      • deleteDatabaseToolsDatabaseApiGatewayConfigPool

        DeleteDatabaseToolsDatabaseApiGatewayConfigPoolResponse deleteDatabaseToolsDatabaseApiGatewayConfigPool​(DeleteDatabaseToolsDatabaseApiGatewayConfigPoolRequest request)
        Deletes the specified Database Tools database API gateway config pool 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 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.86.2/databasetoolsruntime/DeleteDatabaseToolsDatabaseApiGatewayConfigPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDatabaseToolsDatabaseApiGatewayConfigPool API.

      • deleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec

        DeleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse deleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec​(DeleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest request)
        Deletes the specified Database Tools database API gateway config API spec 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 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.86.2/databasetoolsruntime/DeleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec API.

      • deleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec

        DeleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse deleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec​(DeleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest request)
        Deletes the specified Database Tools database API gateway config auto API spec 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 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.86.2/databasetoolsruntime/DeleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec API.

      • executeSqlDatabaseToolsConnection

        ExecuteSqlDatabaseToolsConnectionResponse executeSqlDatabaseToolsConnection​(ExecuteSqlDatabaseToolsConnectionRequest request)
        Execute statements on a 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.86.2/databasetoolsruntime/ExecuteSqlDatabaseToolsConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExecuteSqlDatabaseToolsConnection API.

      • getCredential

        GetCredentialResponse getCredential​(GetCredentialRequest request)
        Get a 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 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.86.2/databasetoolsruntime/GetCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCredential API.

      • getCredentialExecuteGrantee

        GetCredentialExecuteGranteeResponse getCredentialExecuteGrantee​(GetCredentialExecuteGranteeRequest request)
        Get a credential execute grantee
        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.86.2/databasetoolsruntime/GetCredentialExecuteGranteeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCredentialExecuteGrantee API.

      • getCredentialPublicSynonym

        GetCredentialPublicSynonymResponse getCredentialPublicSynonym​(GetCredentialPublicSynonymRequest request)
        Get a public synonym
        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.86.2/databasetoolsruntime/GetCredentialPublicSynonymExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCredentialPublicSynonym API.

      • getDatabaseToolsDatabaseApiGatewayConfigContent

        GetDatabaseToolsDatabaseApiGatewayConfigContentResponse getDatabaseToolsDatabaseApiGatewayConfigContent​(GetDatabaseToolsDatabaseApiGatewayConfigContentRequest request)
        Get the content of a Database Tools database API gateway config
        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.86.2/databasetoolsruntime/GetDatabaseToolsDatabaseApiGatewayConfigContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsDatabaseApiGatewayConfigContent API.

      • getDatabaseToolsDatabaseApiGatewayConfigGlobal

        GetDatabaseToolsDatabaseApiGatewayConfigGlobalResponse getDatabaseToolsDatabaseApiGatewayConfigGlobal​(GetDatabaseToolsDatabaseApiGatewayConfigGlobalRequest request)
        Get a Database Tools database API gateway config global 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 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.86.2/databasetoolsruntime/GetDatabaseToolsDatabaseApiGatewayConfigGlobalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsDatabaseApiGatewayConfigGlobal API.

      • getDatabaseToolsDatabaseApiGatewayConfigPool

        GetDatabaseToolsDatabaseApiGatewayConfigPoolResponse getDatabaseToolsDatabaseApiGatewayConfigPool​(GetDatabaseToolsDatabaseApiGatewayConfigPoolRequest request)
        Get a Database Tools database API gateway config pool 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 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.86.2/databasetoolsruntime/GetDatabaseToolsDatabaseApiGatewayConfigPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsDatabaseApiGatewayConfigPool API.

      • getDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec

        GetDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse getDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec​(GetDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest request)
        Get a Database Tools database API gateway config API spec 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 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.86.2/databasetoolsruntime/GetDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec API.

      • getDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec

        GetDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse getDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec​(GetDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest request)
        Get a Database Tools database API gateway config auto API spec 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 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.86.2/databasetoolsruntime/GetDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec API.

      • getPropertySet

        GetPropertySetResponse getPropertySet​(GetPropertySetRequest request)
        Get a property set
        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.86.2/databasetoolsruntime/GetPropertySetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPropertySet API.

      • getUserCredential

        GetUserCredentialResponse getUserCredential​(GetUserCredentialRequest request)
        Get a user 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 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.86.2/databasetoolsruntime/GetUserCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUserCredential 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.86.2/databasetoolsruntime/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listCredentialExecuteGrantees

        ListCredentialExecuteGranteesResponse listCredentialExecuteGrantees​(ListCredentialExecuteGranteesRequest request)
        Get a list of all execute grantees
        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.86.2/databasetoolsruntime/ListCredentialExecuteGranteesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCredentialExecuteGrantees API.

      • listCredentialPublicSynonyms

        ListCredentialPublicSynonymsResponse listCredentialPublicSynonyms​(ListCredentialPublicSynonymsRequest request)
        Get a list of all public synonyms for the given 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 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.86.2/databasetoolsruntime/ListCredentialPublicSynonymsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCredentialPublicSynonyms API.

      • listCredentials

        ListCredentialsResponse listCredentials​(ListCredentialsRequest request)
        Returns a paginated list of CredentialSummary for the specified 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.86.2/databasetoolsruntime/ListCredentialsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCredentials API.

      • listDatabaseToolsDatabaseApiGatewayConfigAdvancedProperties

        ListDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesResponse listDatabaseToolsDatabaseApiGatewayConfigAdvancedProperties​(ListDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesRequest request)
        Returns list of database API gateway config setting descriptions to be provided as advanced properties.
        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.86.2/databasetoolsruntime/ListDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseToolsDatabaseApiGatewayConfigAdvancedProperties API.

      • listDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecs

        ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsResponse listDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecs​(ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsRequest request)
        Returns a list of Database Tools database API gateway config API spec resources
        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.86.2/databasetoolsruntime/ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecs API.

      • listDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecs

        ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsResponse listDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecs​(ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsRequest request)
        Returns a list of Database Tools database API gateway config auto API spec resources
        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.86.2/databasetoolsruntime/ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecs API.

      • listDatabaseToolsDatabaseApiGatewayConfigPools

        ListDatabaseToolsDatabaseApiGatewayConfigPoolsResponse listDatabaseToolsDatabaseApiGatewayConfigPools​(ListDatabaseToolsDatabaseApiGatewayConfigPoolsRequest request)
        Returns a list of Database Tools database API gateway config pool resources
        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.86.2/databasetoolsruntime/ListDatabaseToolsDatabaseApiGatewayConfigPoolsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseToolsDatabaseApiGatewayConfigPools API.

      • listUserCredentials

        ListUserCredentialsResponse listUserCredentials​(ListUserCredentialsRequest request)
        Returns a paginated list of user UserCredentialSummary for the specified 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.86.2/databasetoolsruntime/ListUserCredentialsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUserCredentials 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.86.2/databasetoolsruntime/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.86.2/databasetoolsruntime/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.86.2/databasetoolsruntime/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • updateCredential

        UpdateCredentialResponse updateCredential​(UpdateCredentialRequest request)
        Update a 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 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.86.2/databasetoolsruntime/UpdateCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCredential API.

      • updateDatabaseToolsDatabaseApiGatewayConfigGlobal

        UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalResponse updateDatabaseToolsDatabaseApiGatewayConfigGlobal​(UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalRequest request)
        Update a Database Tools database API gateway config global 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 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.86.2/databasetoolsruntime/UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatabaseToolsDatabaseApiGatewayConfigGlobal API.

      • updateDatabaseToolsDatabaseApiGatewayConfigPool

        UpdateDatabaseToolsDatabaseApiGatewayConfigPoolResponse updateDatabaseToolsDatabaseApiGatewayConfigPool​(UpdateDatabaseToolsDatabaseApiGatewayConfigPoolRequest request)
        Update a Database Tools database API gateway config pool 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 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.86.2/databasetoolsruntime/UpdateDatabaseToolsDatabaseApiGatewayConfigPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatabaseToolsDatabaseApiGatewayConfigPool API.

      • updateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec

        UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse updateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec​(UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest request)
        Update a Database Tools database API gateway config API spec 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 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.86.2/databasetoolsruntime/UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec API.

      • updateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec

        UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse updateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec​(UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest request)
        Update a Database Tools database API gateway config auto API spec 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 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.86.2/databasetoolsruntime/UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec API.

      • updatePropertySet

        UpdatePropertySetResponse updatePropertySet​(UpdatePropertySetRequest request)
        Update a property set
        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.86.2/databasetoolsruntime/UpdatePropertySetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePropertySet API.

      • validateDatabaseToolsConnection

        ValidateDatabaseToolsConnectionResponse validateDatabaseToolsConnection​(ValidateDatabaseToolsConnectionRequest request)
        Validates 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.86.2/databasetoolsruntime/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 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.86.2/databasetoolsruntime/ValidateDatabaseToolsIdentityCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateDatabaseToolsIdentityCredential API.

      • getWaiters

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

      • getPaginators

        DatabaseToolsRuntimePaginators 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.