Interface DataCatalog

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DataCatalogClient

    @Generated(value="OracleSDKGenerator",
               comments="API Version: 20190325")
    public interface DataCatalog
    extends AutoCloseable
    Use the Data Catalog APIs to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.

    For more information, see Data Catalog.

    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
      • addCatalogLock

        AddCatalogLockResponse addCatalogLock​(AddCatalogLockRequest request)
        Adds a lock to a Catalog 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.63.0/datacatalog/AddCatalogLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddCatalogLock API.

      • addCatalogPrivateEndpointLock

        AddCatalogPrivateEndpointLockResponse addCatalogPrivateEndpointLock​(AddCatalogPrivateEndpointLockRequest request)
        Adds a lock to a CatalogPrivateEndpoint 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.63.0/datacatalog/AddCatalogPrivateEndpointLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddCatalogPrivateEndpointLock API.

      • addDataSelectorPatterns

        AddDataSelectorPatternsResponse addDataSelectorPatterns​(AddDataSelectorPatternsRequest request)
        Add data selector pattern to the data asset.
        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.63.0/datacatalog/AddDataSelectorPatternsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDataSelectorPatterns API.

      • addMetastoreLock

        AddMetastoreLockResponse addMetastoreLock​(AddMetastoreLockRequest request)
        Adds a lock to a Metastore 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.63.0/datacatalog/AddMetastoreLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddMetastoreLock API.

      • associateCustomProperty

        AssociateCustomPropertyResponse associateCustomProperty​(AssociateCustomPropertyRequest request)
        Associate the custom property for the given type
        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.63.0/datacatalog/AssociateCustomPropertyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AssociateCustomProperty API.

      • asynchronousExportDataAsset

        AsynchronousExportDataAssetResponse asynchronousExportDataAsset​(AsynchronousExportDataAssetRequest request)
        Export technical objects from a Data Asset in Excel format.

        Returns details about the job which actually performs the export.

        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.63.0/datacatalog/AsynchronousExportDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AsynchronousExportDataAsset API.

      • asynchronousExportGlossary

        AsynchronousExportGlossaryResponse asynchronousExportGlossary​(AsynchronousExportGlossaryRequest request)
        Exports the contents of a glossary in Excel format.

        Returns details about the job which actually performs the export.

        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.63.0/datacatalog/AsynchronousExportGlossaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AsynchronousExportGlossary API.

      • attachCatalogPrivateEndpoint

        AttachCatalogPrivateEndpointResponse attachCatalogPrivateEndpoint​(AttachCatalogPrivateEndpointRequest request)
        Attaches a private reverse connection endpoint resource to a data catalog resource.

        When provided, ‘If-Match’ is checked against ‘ETag’ values of the 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.63.0/datacatalog/AttachCatalogPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachCatalogPrivateEndpoint API.

      • changeCatalogCompartment

        ChangeCatalogCompartmentResponse changeCatalogCompartment​(ChangeCatalogCompartmentRequest request)
        Moves a resource into a different compartment.

        When provided, ‘If-Match’ is checked against ‘ETag’ values of the 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.63.0/datacatalog/ChangeCatalogCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeCatalogCompartment API.

      • changeCatalogPrivateEndpointCompartment

        ChangeCatalogPrivateEndpointCompartmentResponse changeCatalogPrivateEndpointCompartment​(ChangeCatalogPrivateEndpointCompartmentRequest request)
        Moves a resource into a different compartment.

        When provided, ‘If-Match’ is checked against ‘ETag’ values of the 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.63.0/datacatalog/ChangeCatalogPrivateEndpointCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeCatalogPrivateEndpointCompartment API.

      • changeMetastoreCompartment

        ChangeMetastoreCompartmentResponse changeMetastoreCompartment​(ChangeMetastoreCompartmentRequest request)
        Moves a resource into a different compartment.

        When provided, ‘If-Match’ is checked against ‘ETag’ values of the 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.63.0/datacatalog/ChangeMetastoreCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeMetastoreCompartment API.

      • createAttribute

        CreateAttributeResponse createAttribute​(CreateAttributeRequest request)
        Creates a new entity attribute.
        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.63.0/datacatalog/CreateAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAttribute API.

      • createAttributeTag

        CreateAttributeTagResponse createAttributeTag​(CreateAttributeTagRequest request)
        Creates a new entity attribute tag.
        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.63.0/datacatalog/CreateAttributeTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAttributeTag API.

      • createCatalog

        CreateCatalogResponse createCatalog​(CreateCatalogRequest request)
        Creates a new data catalog instance that includes a console and an API URL for managing metadata operations.

        For more information, please see the documentation.

        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.63.0/datacatalog/CreateCatalogExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCatalog API.

      • createCatalogPrivateEndpoint

        CreateCatalogPrivateEndpointResponse createCatalogPrivateEndpoint​(CreateCatalogPrivateEndpointRequest request)
        Create a new private reverse connection 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.63.0/datacatalog/CreateCatalogPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCatalogPrivateEndpoint API.

      • createConnection

        CreateConnectionResponse createConnection​(CreateConnectionRequest request)
        Creates a new 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.63.0/datacatalog/CreateConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateConnection API.

      • createCustomProperty

        CreateCustomPropertyResponse createCustomProperty​(CreateCustomPropertyRequest request)
        Create a new Custom Property
        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.63.0/datacatalog/CreateCustomPropertyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCustomProperty API.

      • createDataAsset

        CreateDataAssetResponse createDataAsset​(CreateDataAssetRequest request)
        Create a new data asset.
        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.63.0/datacatalog/CreateDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDataAsset API.

      • createDataAssetTag

        CreateDataAssetTagResponse createDataAssetTag​(CreateDataAssetTagRequest request)
        Creates a new data asset tag.
        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.63.0/datacatalog/CreateDataAssetTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDataAssetTag API.

      • createEntity

        CreateEntityResponse createEntity​(CreateEntityRequest request)
        Creates a new data entity.
        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.63.0/datacatalog/CreateEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateEntity API.

      • createEntityTag

        CreateEntityTagResponse createEntityTag​(CreateEntityTagRequest request)
        Creates a new entity tag.
        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.63.0/datacatalog/CreateEntityTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateEntityTag API.

      • createFolder

        CreateFolderResponse createFolder​(CreateFolderRequest request)
        Creates a new folder.
        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.63.0/datacatalog/CreateFolderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateFolder API.

      • createFolderTag

        CreateFolderTagResponse createFolderTag​(CreateFolderTagRequest request)
        Creates a new folder tag.
        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.63.0/datacatalog/CreateFolderTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateFolderTag API.

      • createGlossary

        CreateGlossaryResponse createGlossary​(CreateGlossaryRequest request)
        Creates a new glossary.
        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.63.0/datacatalog/CreateGlossaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateGlossary API.

      • createJob

        CreateJobResponse createJob​(CreateJobRequest request)
        Creates a new job.
        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.63.0/datacatalog/CreateJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateJob API.

      • createJobDefinition

        CreateJobDefinitionResponse createJobDefinition​(CreateJobDefinitionRequest request)
        Creates a new job definition.
        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.63.0/datacatalog/CreateJobDefinitionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateJobDefinition API.

      • createJobExecution

        CreateJobExecutionResponse createJobExecution​(CreateJobExecutionRequest request)
        Creates a new job execution.
        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.63.0/datacatalog/CreateJobExecutionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateJobExecution API.

      • createMetastore

        CreateMetastoreResponse createMetastore​(CreateMetastoreRequest request)
        Creates a new metastore.
        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.63.0/datacatalog/CreateMetastoreExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateMetastore API.

      • createNamespace

        CreateNamespaceResponse createNamespace​(CreateNamespaceRequest request)
        Create a new Namespace to be used by a custom property
        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.63.0/datacatalog/CreateNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateNamespace API.

      • createPattern

        CreatePatternResponse createPattern​(CreatePatternRequest request)
        Create a new pattern.
        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.63.0/datacatalog/CreatePatternExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePattern API.

      • createTerm

        CreateTermResponse createTerm​(CreateTermRequest request)
        Create a new term within a glossary.
        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.63.0/datacatalog/CreateTermExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTerm API.

      • createTermRelationship

        CreateTermRelationshipResponse createTermRelationship​(CreateTermRelationshipRequest request)
        Creates a new term relationship for this term within a glossary.
        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.63.0/datacatalog/CreateTermRelationshipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTermRelationship API.

      • deleteAttribute

        DeleteAttributeResponse deleteAttribute​(DeleteAttributeRequest request)
        Deletes a specific entity attribute.
        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.63.0/datacatalog/DeleteAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAttribute API.

      • deleteAttributeTag

        DeleteAttributeTagResponse deleteAttributeTag​(DeleteAttributeTagRequest request)
        Deletes a specific entity attribute tag.
        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.63.0/datacatalog/DeleteAttributeTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAttributeTag API.

      • deleteCatalog

        DeleteCatalogResponse deleteCatalog​(DeleteCatalogRequest request)
        Deletes a data catalog resource by identifier.
        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.63.0/datacatalog/DeleteCatalogExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCatalog API.

      • deleteCatalogPrivateEndpoint

        DeleteCatalogPrivateEndpointResponse deleteCatalogPrivateEndpoint​(DeleteCatalogPrivateEndpointRequest request)
        Deletes a private reverse connection endpoint by identifier.
        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.63.0/datacatalog/DeleteCatalogPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCatalogPrivateEndpoint API.

      • deleteConnection

        DeleteConnectionResponse deleteConnection​(DeleteConnectionRequest request)
        Deletes a specific connection of a data asset.
        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.63.0/datacatalog/DeleteConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteConnection API.

      • deleteCustomProperty

        DeleteCustomPropertyResponse deleteCustomProperty​(DeleteCustomPropertyRequest request)
        Deletes a specific custom property identified by it’s 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 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.63.0/datacatalog/DeleteCustomPropertyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCustomProperty API.

      • deleteDataAsset

        DeleteDataAssetResponse deleteDataAsset​(DeleteDataAssetRequest request)
        Deletes a specific data asset identified by it’s 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 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.63.0/datacatalog/DeleteDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDataAsset API.

      • deleteDataAssetTag

        DeleteDataAssetTagResponse deleteDataAssetTag​(DeleteDataAssetTagRequest request)
        Deletes a specific data asset tag.
        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.63.0/datacatalog/DeleteDataAssetTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDataAssetTag API.

      • deleteEntity

        DeleteEntityResponse deleteEntity​(DeleteEntityRequest request)
        Deletes a specific data entity.
        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.63.0/datacatalog/DeleteEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteEntity API.

      • deleteEntityTag

        DeleteEntityTagResponse deleteEntityTag​(DeleteEntityTagRequest request)
        Deletes a specific entity tag.
        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.63.0/datacatalog/DeleteEntityTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteEntityTag API.

      • deleteFolder

        DeleteFolderResponse deleteFolder​(DeleteFolderRequest request)
        Deletes a specific folder of a data asset identified by it’s 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 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.63.0/datacatalog/DeleteFolderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteFolder API.

      • deleteFolderTag

        DeleteFolderTagResponse deleteFolderTag​(DeleteFolderTagRequest request)
        Deletes a specific folder tag.
        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.63.0/datacatalog/DeleteFolderTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteFolderTag API.

      • deleteGlossary

        DeleteGlossaryResponse deleteGlossary​(DeleteGlossaryRequest request)
        Deletes a specific glossary identified by it’s 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 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.63.0/datacatalog/DeleteGlossaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteGlossary API.

      • deleteJob

        DeleteJobResponse deleteJob​(DeleteJobRequest request)
        Deletes a specific job identified by it’s 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 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.63.0/datacatalog/DeleteJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteJob API.

      • deleteJobDefinition

        DeleteJobDefinitionResponse deleteJobDefinition​(DeleteJobDefinitionRequest request)
        Deletes a specific job definition identified by it’s 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 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.63.0/datacatalog/DeleteJobDefinitionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteJobDefinition API.

      • deleteMetastore

        DeleteMetastoreResponse deleteMetastore​(DeleteMetastoreRequest request)
        Deletes a metastore resource by identifier.
        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.63.0/datacatalog/DeleteMetastoreExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteMetastore API.

      • deleteNamespace

        DeleteNamespaceResponse deleteNamespace​(DeleteNamespaceRequest request)
        Deletes a specific Namespace identified by it’s 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 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.63.0/datacatalog/DeleteNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteNamespace API.

      • deletePattern

        DeletePatternResponse deletePattern​(DeletePatternRequest request)
        Deletes a specific pattern identified by it’s 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 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.63.0/datacatalog/DeletePatternExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePattern API.

      • deleteTerm

        DeleteTermResponse deleteTerm​(DeleteTermRequest request)
        Deletes a specific glossary term.
        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.63.0/datacatalog/DeleteTermExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTerm API.

      • deleteTermRelationship

        DeleteTermRelationshipResponse deleteTermRelationship​(DeleteTermRelationshipRequest request)
        Deletes a specific glossary term relationship.
        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.63.0/datacatalog/DeleteTermRelationshipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTermRelationship API.

      • detachCatalogPrivateEndpoint

        DetachCatalogPrivateEndpointResponse detachCatalogPrivateEndpoint​(DetachCatalogPrivateEndpointRequest request)
        Detaches a private reverse connection endpoint resource to a data catalog resource.

        When provided, ‘If-Match’ is checked against ‘ETag’ values of the 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.63.0/datacatalog/DetachCatalogPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetachCatalogPrivateEndpoint API.

      • disassociateCustomProperty

        DisassociateCustomPropertyResponse disassociateCustomProperty​(DisassociateCustomPropertyRequest request)
        Remove the custom property for the given type
        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.63.0/datacatalog/DisassociateCustomPropertyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DisassociateCustomProperty API.

      • expandTreeForGlossary

        ExpandTreeForGlossaryResponse expandTreeForGlossary​(ExpandTreeForGlossaryRequest request)
        Returns the fully expanded tree hierarchy of parent and child terms in this glossary.
        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.63.0/datacatalog/ExpandTreeForGlossaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExpandTreeForGlossary API.

      • exportGlossary

        ExportGlossaryResponse exportGlossary​(ExportGlossaryRequest request)
        Export the glossary and the terms and return the exported glossary as csv or json.
        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.63.0/datacatalog/ExportGlossaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportGlossary API.

      • fetchEntityLineage

        FetchEntityLineageResponse fetchEntityLineage​(FetchEntityLineageRequest request)
        Returns lineage for a given entity object.
        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.63.0/datacatalog/FetchEntityLineageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use FetchEntityLineage API.

      • getAttribute

        GetAttributeResponse getAttribute​(GetAttributeRequest request)
        Gets a specific entity attribute by 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.63.0/datacatalog/GetAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAttribute API.

      • getAttributeTag

        GetAttributeTagResponse getAttributeTag​(GetAttributeTagRequest request)
        Gets a specific entity attribute tag by 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.63.0/datacatalog/GetAttributeTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAttributeTag API.

      • getCatalog

        GetCatalogResponse getCatalog​(GetCatalogRequest request)
        Gets a data catalog by identifier.
        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.63.0/datacatalog/GetCatalogExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCatalog API.

      • getCatalogPrivateEndpoint

        GetCatalogPrivateEndpointResponse getCatalogPrivateEndpoint​(GetCatalogPrivateEndpointRequest request)
        Gets a specific private reverse connection by identifier.
        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.63.0/datacatalog/GetCatalogPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCatalogPrivateEndpoint API.

      • getConnection

        GetConnectionResponse getConnection​(GetConnectionRequest request)
        Gets a specific data asset connection by 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.63.0/datacatalog/GetConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConnection API.

      • getCustomProperty

        GetCustomPropertyResponse getCustomProperty​(GetCustomPropertyRequest request)
        Gets a specific custom property for the given key within a data catalog.
        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.63.0/datacatalog/GetCustomPropertyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCustomProperty API.

      • getDataAsset

        GetDataAssetResponse getDataAsset​(GetDataAssetRequest request)
        Gets a specific data asset for the given key within a data catalog.
        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.63.0/datacatalog/GetDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDataAsset API.

      • getDataAssetTag

        GetDataAssetTagResponse getDataAssetTag​(GetDataAssetTagRequest request)
        Gets a specific data asset tag by 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.63.0/datacatalog/GetDataAssetTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDataAssetTag API.

      • getEntity

        GetEntityResponse getEntity​(GetEntityRequest request)
        Gets a specific data entity by key for a data asset.
        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.63.0/datacatalog/GetEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEntity API.

      • getEntityTag

        GetEntityTagResponse getEntityTag​(GetEntityTagRequest request)
        Gets a specific entity tag by 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.63.0/datacatalog/GetEntityTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEntityTag API.

      • getFolder

        GetFolderResponse getFolder​(GetFolderRequest request)
        Gets a specific data asset folder by 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.63.0/datacatalog/GetFolderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetFolder API.

      • getFolderTag

        GetFolderTagResponse getFolderTag​(GetFolderTagRequest request)
        Gets a specific folder tag by 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.63.0/datacatalog/GetFolderTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetFolderTag API.

      • getGlossary

        GetGlossaryResponse getGlossary​(GetGlossaryRequest request)
        Gets a specific glossary by key within a data catalog.
        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.63.0/datacatalog/GetGlossaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetGlossary API.

      • getJob

        GetJobResponse getJob​(GetJobRequest request)
        Gets a specific job by key within a data catalog.
        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.63.0/datacatalog/GetJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetJob API.

      • getJobDefinition

        GetJobDefinitionResponse getJobDefinition​(GetJobDefinitionRequest request)
        Gets a specific job definition by key within a data catalog.
        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.63.0/datacatalog/GetJobDefinitionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetJobDefinition API.

      • getJobExecution

        GetJobExecutionResponse getJobExecution​(GetJobExecutionRequest request)
        Gets a specific job execution by 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.63.0/datacatalog/GetJobExecutionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetJobExecution API.

      • getJobLog

        GetJobLogResponse getJobLog​(GetJobLogRequest request)
        Gets a specific job log by 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.63.0/datacatalog/GetJobLogExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetJobLog API.

      • getJobMetrics

        GetJobMetricsResponse getJobMetrics​(GetJobMetricsRequest request)
        Gets a specific job metric by 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.63.0/datacatalog/GetJobMetricsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetJobMetrics API.

      • getMetastore

        GetMetastoreResponse getMetastore​(GetMetastoreRequest request)
        Gets a metastore by identifier.
        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.63.0/datacatalog/GetMetastoreExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetMetastore API.

      • getNamespace

        GetNamespaceResponse getNamespace​(GetNamespaceRequest request)
        Gets a specific namespace for the given key within a data catalog.
        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.63.0/datacatalog/GetNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetNamespace API.

      • getPattern

        GetPatternResponse getPattern​(GetPatternRequest request)
        Gets a specific pattern for the given key within a data catalog.
        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.63.0/datacatalog/GetPatternExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPattern API.

      • getTerm

        GetTermResponse getTerm​(GetTermRequest request)
        Gets a specific glossary term by 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.63.0/datacatalog/GetTermExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTerm API.

      • getTermRelationship

        GetTermRelationshipResponse getTermRelationship​(GetTermRelationshipRequest request)
        Gets a specific glossary term relationship by 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.63.0/datacatalog/GetTermRelationshipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTermRelationship API.

      • getType

        GetTypeResponse getType​(GetTypeRequest request)
        Gets a specific type by key within a data catalog.
        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.63.0/datacatalog/GetTypeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetType API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets the status of the work request with the given OCID.
        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.63.0/datacatalog/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • importConnection

        ImportConnectionResponse importConnection​(ImportConnectionRequest request)
        Import new connection for this data asset.
        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.63.0/datacatalog/ImportConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportConnection API.

      • importDataAsset

        ImportDataAssetResponse importDataAsset​(ImportDataAssetRequest request)
        Import technical objects to a Data Asset
        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.63.0/datacatalog/ImportDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportDataAsset API.

      • importGlossary

        ImportGlossaryResponse importGlossary​(ImportGlossaryRequest request)
        Import the glossary and the terms from csv or json files and return the imported glossary 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.63.0/datacatalog/ImportGlossaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportGlossary API.

      • importLineage

        ImportLineageResponse importLineage​(ImportLineageRequest request)
        Imports lineage metadata.

        Returns details about the job that performs the import.

        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.63.0/datacatalog/ImportLineageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportLineage API.

      • listAggregatedPhysicalEntities

        ListAggregatedPhysicalEntitiesResponse listAggregatedPhysicalEntities​(ListAggregatedPhysicalEntitiesRequest request)
        List the physical entities aggregated by this logical entity.
        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.63.0/datacatalog/ListAggregatedPhysicalEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAggregatedPhysicalEntities API.

      • listAttributeTags

        ListAttributeTagsResponse listAttributeTags​(ListAttributeTagsRequest request)
        Returns a list of all tags for an entity attribute.
        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.63.0/datacatalog/ListAttributeTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAttributeTags API.

      • listAttributes

        ListAttributesResponse listAttributes​(ListAttributesRequest request)
        Returns a list of all attributes of an data entity.
        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.63.0/datacatalog/ListAttributesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAttributes API.

      • listCatalogPrivateEndpoints

        ListCatalogPrivateEndpointsResponse listCatalogPrivateEndpoints​(ListCatalogPrivateEndpointsRequest request)
        Returns a list of all the catalog private endpoints in the specified 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.63.0/datacatalog/ListCatalogPrivateEndpointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCatalogPrivateEndpoints API.

      • listCatalogs

        ListCatalogsResponse listCatalogs​(ListCatalogsRequest request)
        Returns a list of all the data catalogs in the specified 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.63.0/datacatalog/ListCatalogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCatalogs API.

      • listConnections

        ListConnectionsResponse listConnections​(ListConnectionsRequest request)
        Returns a list of all Connections for a data asset.
        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.63.0/datacatalog/ListConnectionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListConnections API.

      • listCustomProperties

        ListCustomPropertiesResponse listCustomProperties​(ListCustomPropertiesRequest request)
        Returns a list of custom properties within a data catalog.
        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.63.0/datacatalog/ListCustomPropertiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCustomProperties API.

      • listDataAssetTags

        ListDataAssetTagsResponse listDataAssetTags​(ListDataAssetTagsRequest request)
        Returns a list of all tags for a data asset.
        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.63.0/datacatalog/ListDataAssetTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDataAssetTags API.

      • listDataAssets

        ListDataAssetsResponse listDataAssets​(ListDataAssetsRequest request)
        Returns a list of data assets within a data catalog.
        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.63.0/datacatalog/ListDataAssetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDataAssets API.

      • listDerivedLogicalEntities

        ListDerivedLogicalEntitiesResponse listDerivedLogicalEntities​(ListDerivedLogicalEntitiesRequest request)
        List logical entities derived from this pattern.
        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.63.0/datacatalog/ListDerivedLogicalEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDerivedLogicalEntities API.

      • listEntities

        ListEntitiesResponse listEntities​(ListEntitiesRequest request)
        Returns a list of all entities of a data asset.
        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.63.0/datacatalog/ListEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEntities API.

      • listEntityTags

        ListEntityTagsResponse listEntityTags​(ListEntityTagsRequest request)
        Returns a list of all tags for a data entity.
        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.63.0/datacatalog/ListEntityTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEntityTags API.

      • listFolderTags

        ListFolderTagsResponse listFolderTags​(ListFolderTagsRequest request)
        Returns a list of all tags for a folder.
        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.63.0/datacatalog/ListFolderTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFolderTags API.

      • listFolders

        ListFoldersResponse listFolders​(ListFoldersRequest request)
        Returns a list of all folders.
        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.63.0/datacatalog/ListFoldersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFolders API.

      • listGlossaries

        ListGlossariesResponse listGlossaries​(ListGlossariesRequest request)
        Returns a list of all glossaries within a data catalog.
        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.63.0/datacatalog/ListGlossariesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListGlossaries API.

      • listJobDefinitions

        ListJobDefinitionsResponse listJobDefinitions​(ListJobDefinitionsRequest request)
        Returns a list of job definitions within a data catalog.
        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.63.0/datacatalog/ListJobDefinitionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListJobDefinitions API.

      • listJobExecutions

        ListJobExecutionsResponse listJobExecutions​(ListJobExecutionsRequest request)
        Returns a list of job executions for a job.
        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.63.0/datacatalog/ListJobExecutionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListJobExecutions API.

      • listJobLogs

        ListJobLogsResponse listJobLogs​(ListJobLogsRequest request)
        Returns a list of job logs.
        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.63.0/datacatalog/ListJobLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListJobLogs API.

      • listJobMetrics

        ListJobMetricsResponse listJobMetrics​(ListJobMetricsRequest request)
        Returns a list of job metrics.
        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.63.0/datacatalog/ListJobMetricsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListJobMetrics API.

      • listJobs

        ListJobsResponse listJobs​(ListJobsRequest request)
        Returns a list of jobs within a data catalog.
        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.63.0/datacatalog/ListJobsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListJobs API.

      • listMetastores

        ListMetastoresResponse listMetastores​(ListMetastoresRequest request)
        Returns a list of all metastores in the specified 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.63.0/datacatalog/ListMetastoresExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListMetastores API.

      • listNamespaces

        ListNamespacesResponse listNamespaces​(ListNamespacesRequest request)
        Returns a list of namespaces within a data catalog.
        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.63.0/datacatalog/ListNamespacesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListNamespaces API.

      • listPatterns

        ListPatternsResponse listPatterns​(ListPatternsRequest request)
        Returns a list of patterns within a data catalog.
        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.63.0/datacatalog/ListPatternsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPatterns API.

      • listRules

        ListRulesResponse listRules​(ListRulesRequest request)
        Returns a list of all rules of a data entity.
        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.63.0/datacatalog/ListRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRules API.

      • listTags

        ListTagsResponse listTags​(ListTagsRequest request)
        Returns a list of all user created tags in the system.
        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.63.0/datacatalog/ListTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTags API.

      • listTermRelationships

        ListTermRelationshipsResponse listTermRelationships​(ListTermRelationshipsRequest request)
        Returns a list of all term relationships within a glossary.
        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.63.0/datacatalog/ListTermRelationshipsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTermRelationships API.

      • listTerms

        ListTermsResponse listTerms​(ListTermsRequest request)
        Returns a list of all terms within a glossary.
        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.63.0/datacatalog/ListTermsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTerms API.

      • listTypes

        ListTypesResponse listTypes​(ListTypesRequest request)
        Returns a list of all types within a data catalog.
        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.63.0/datacatalog/ListTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTypes API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Returns a (paginated) list of errors for a given 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.63.0/datacatalog/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 a given 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.63.0/datacatalog/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.63.0/datacatalog/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • objectStats

        ObjectStatsResponse objectStats​(ObjectStatsRequest request)
        Returns stats on objects by type in the repository.
        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.63.0/datacatalog/ObjectStatsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ObjectStats API.

      • parseConnection

        ParseConnectionResponse parseConnection​(ParseConnectionRequest request)
        Parse data asset references through connections from this data asset.
        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.63.0/datacatalog/ParseConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ParseConnection API.

      • processRecommendation

        ProcessRecommendationResponse processRecommendation​(ProcessRecommendationRequest request)
        Act on a recommendation.

        A recommendation can be accepted or rejected. For example, if a recommendation of type LINK_GLOSSARY_TERM is accepted, the system will link the source object (e.g. an attribute) to a target glossary term.

        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.63.0/datacatalog/ProcessRecommendationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ProcessRecommendation API.

      • recommendations

        RecommendationsResponse recommendations​(RecommendationsRequest request)
        Returns a list of recommendations for the given object and recommendation type.

        By default, it will return inferred recommendations for review. The optional query param ‘RecommendationStatus’ can be set, to return only recommendations having that status.

        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.63.0/datacatalog/RecommendationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use Recommendations API.

      • removeCatalogLock

        RemoveCatalogLockResponse removeCatalogLock​(RemoveCatalogLockRequest request)
        Removes a lock from a Catalog 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.63.0/datacatalog/RemoveCatalogLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveCatalogLock API.

      • removeCatalogPrivateEndpointLock

        RemoveCatalogPrivateEndpointLockResponse removeCatalogPrivateEndpointLock​(RemoveCatalogPrivateEndpointLockRequest request)
        Removes a lock from a CatalogPrivateEndpoint 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.63.0/datacatalog/RemoveCatalogPrivateEndpointLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveCatalogPrivateEndpointLock API.

      • removeDataSelectorPatterns

        RemoveDataSelectorPatternsResponse removeDataSelectorPatterns​(RemoveDataSelectorPatternsRequest request)
        Remove data selector pattern from the data asset.
        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.63.0/datacatalog/RemoveDataSelectorPatternsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveDataSelectorPatterns API.

      • removeMetastoreLock

        RemoveMetastoreLockResponse removeMetastoreLock​(RemoveMetastoreLockRequest request)
        Removes a lock from a Metastore 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.63.0/datacatalog/RemoveMetastoreLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveMetastoreLock API.

      • searchCriteria

        SearchCriteriaResponse searchCriteria​(SearchCriteriaRequest request)
        Returns a list of search results within a data catalog.
        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.63.0/datacatalog/SearchCriteriaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SearchCriteria API.

      • suggestMatches

        SuggestMatchesResponse suggestMatches​(SuggestMatchesRequest request)
        Returns a list of potential string matches for a given input string.
        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.63.0/datacatalog/SuggestMatchesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SuggestMatches API.

      • synchronousExportDataAsset

        SynchronousExportDataAssetResponse synchronousExportDataAsset​(SynchronousExportDataAssetRequest request)
        Export technical objects from a Data Asset
        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.63.0/datacatalog/SynchronousExportDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SynchronousExportDataAsset API.

      • testConnection

        TestConnectionResponse testConnection​(TestConnectionRequest request)
        Test the connection by connecting to the data asset using credentials in the metadata.
        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.63.0/datacatalog/TestConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use TestConnection API.

      • updateAttribute

        UpdateAttributeResponse updateAttribute​(UpdateAttributeRequest request)
        Updates a specific data asset attribute.
        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.63.0/datacatalog/UpdateAttributeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAttribute API.

      • updateCatalog

        UpdateCatalogResponse updateCatalog​(UpdateCatalogRequest request)
        Updates the data catalog.
        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.63.0/datacatalog/UpdateCatalogExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCatalog API.

      • updateCatalogPrivateEndpoint

        UpdateCatalogPrivateEndpointResponse updateCatalogPrivateEndpoint​(UpdateCatalogPrivateEndpointRequest request)
        Updates the private reverse connection 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.63.0/datacatalog/UpdateCatalogPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCatalogPrivateEndpoint API.

      • updateConnection

        UpdateConnectionResponse updateConnection​(UpdateConnectionRequest request)
        Updates a specific connection of a data asset.
        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.63.0/datacatalog/UpdateConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateConnection API.

      • updateCustomProperty

        UpdateCustomPropertyResponse updateCustomProperty​(UpdateCustomPropertyRequest request)
        Updates a specific custom property identified by the given 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 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.63.0/datacatalog/UpdateCustomPropertyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCustomProperty API.

      • updateDataAsset

        UpdateDataAssetResponse updateDataAsset​(UpdateDataAssetRequest request)
        Updates a specific data asset identified by the given 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 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.63.0/datacatalog/UpdateDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDataAsset API.

      • updateEntity

        UpdateEntityResponse updateEntity​(UpdateEntityRequest request)
        Updates a specific data entity.
        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.63.0/datacatalog/UpdateEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateEntity API.

      • updateFolder

        UpdateFolderResponse updateFolder​(UpdateFolderRequest request)
        Updates a specific folder of a data asset.
        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.63.0/datacatalog/UpdateFolderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateFolder API.

      • updateGlossary

        UpdateGlossaryResponse updateGlossary​(UpdateGlossaryRequest request)
        Updates a specific glossary identified by the given 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 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.63.0/datacatalog/UpdateGlossaryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateGlossary API.

      • updateJob

        UpdateJobResponse updateJob​(UpdateJobRequest request)
        Updates a specific job identified by the given 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 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.63.0/datacatalog/UpdateJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateJob API.

      • updateJobDefinition

        UpdateJobDefinitionResponse updateJobDefinition​(UpdateJobDefinitionRequest request)
        Update a specific job definition identified by the given 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 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.63.0/datacatalog/UpdateJobDefinitionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateJobDefinition API.

      • updateMetastore

        UpdateMetastoreResponse updateMetastore​(UpdateMetastoreRequest request)
        Updates a metastore resource by identifier.
        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.63.0/datacatalog/UpdateMetastoreExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateMetastore API.

      • updateNamespace

        UpdateNamespaceResponse updateNamespace​(UpdateNamespaceRequest request)
        Updates a specific namespace identified by the given 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 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.63.0/datacatalog/UpdateNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateNamespace API.

      • updatePattern

        UpdatePatternResponse updatePattern​(UpdatePatternRequest request)
        Updates a specific pattern identified by the given 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 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.63.0/datacatalog/UpdatePatternExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePattern API.

      • updateTerm

        UpdateTermResponse updateTerm​(UpdateTermRequest request)
        Updates a specific glossary term.
        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.63.0/datacatalog/UpdateTermExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTerm API.

      • updateTermRelationship

        UpdateTermRelationshipResponse updateTermRelationship​(UpdateTermRelationshipRequest request)
        Updates a specific glossary term relationship.
        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.63.0/datacatalog/UpdateTermRelationshipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTermRelationship API.

      • uploadCredentials

        UploadCredentialsResponse uploadCredentials​(UploadCredentialsRequest request)
        Upload connection credentails and metadata for this 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.63.0/datacatalog/UploadCredentialsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UploadCredentials API.

      • users

        UsersResponse users​(UsersRequest request)
        Returns active users in the system.
        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.63.0/datacatalog/UsersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use Users API.

      • validateConnection

        ValidateConnectionResponse validateConnection​(ValidateConnectionRequest request)
        Validate connection by connecting to the data asset using credentials in metadata.
        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.63.0/datacatalog/ValidateConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateConnection API.

      • validatePattern

        ValidatePatternResponse validatePattern​(ValidatePatternRequest request)
        Validate pattern by deriving file groups representing logical entities using the expression
        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.63.0/datacatalog/ValidatePatternExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidatePattern API.

      • getWaiters

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

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