Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataCatalogClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DataCatalogClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DataCatalogClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DataCatalogClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "DataCatalog"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://datacatalog.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • 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: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

addCatalogLock

addCatalogPrivateEndpointLock

addDataSelectorPatterns

addMetastoreLock

associateCustomProperty

asynchronousExportDataAsset

  • Export technical objects from a Data Asset in Excel format. Returns details about the job which actually performs the export. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AsynchronousExportDataAsset API.

    Parameters

    Returns Promise<AsynchronousExportDataAssetResponse>

    AsynchronousExportDataAssetResponse

asynchronousExportGlossary

attachCatalogPrivateEndpoint

  • Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AttachCatalogPrivateEndpoint API.

    Parameters

    Returns Promise<AttachCatalogPrivateEndpointResponse>

    AttachCatalogPrivateEndpointResponse

changeCatalogCompartment

  • Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeCatalogCompartment API.

    Parameters

    Returns Promise<ChangeCatalogCompartmentResponse>

    ChangeCatalogCompartmentResponse

changeCatalogPrivateEndpointCompartment

changeMetastoreCompartment

  • Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeMetastoreCompartment API.

    Parameters

    Returns Promise<ChangeMetastoreCompartmentResponse>

    ChangeMetastoreCompartmentResponse

close

  • close(): void

createAttribute

createAttributeTag

createCatalog

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCatalog API.

    Parameters

    Returns Promise<CreateCatalogResponse>

    CreateCatalogResponse

createCatalogPrivateEndpoint

createConnection

createCustomProperty

createDataAsset

createDataAssetTag

createEntity

createEntityTag

createFolder

createFolderTag

createGlossary

createJob

createJobDefinition

createJobExecution

createMetastore

createNamespace

createPattern

createTerm

createTermRelationship

createWaiters

  • Creates a new DataCatalogWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DataCatalogWaiter

    The service waiters.

deleteAttribute

deleteAttributeTag

deleteCatalog

deleteCatalogPrivateEndpoint

deleteConnection

deleteCustomProperty

deleteDataAsset

deleteDataAssetTag

deleteEntity

deleteEntityTag

deleteFolder

  • Deletes a specific folder of a data asset identified by it's key. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteFolder API.

    Parameters

    Returns Promise<DeleteFolderResponse>

    DeleteFolderResponse

deleteFolderTag

deleteGlossary

deleteJob

  • Deletes a specific job identified by it's key. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteJob API.

    Parameters

    Returns Promise<DeleteJobResponse>

    DeleteJobResponse

deleteJobDefinition

deleteMetastore

deleteNamespace

deletePattern

deleteTerm

deleteTermRelationship

detachCatalogPrivateEndpoint

  • Detaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DetachCatalogPrivateEndpoint API.

    Parameters

    Returns Promise<DetachCatalogPrivateEndpointResponse>

    DetachCatalogPrivateEndpointResponse

disassociateCustomProperty

expandTreeForGlossary

  • Returns the fully expanded tree hierarchy of parent and child terms in this glossary. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ExpandTreeForGlossary API.

    Parameters

    Returns Promise<ExpandTreeForGlossaryResponse>

    ExpandTreeForGlossaryResponse

exportGlossary

  • Export the glossary and the terms and return the exported glossary as csv or json. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ExportGlossary API.

    Parameters

    Returns Promise<ExportGlossaryResponse>

    ExportGlossaryResponse

fetchEntityLineage

getAttribute

  • Gets a specific entity attribute by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAttribute API.

    Parameters

    Returns Promise<GetAttributeResponse>

    GetAttributeResponse

getAttributeTag

  • Gets a specific entity attribute tag by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAttributeTag API.

    Parameters

    Returns Promise<GetAttributeTagResponse>

    GetAttributeTagResponse

getCatalog

  • Gets a data catalog by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCatalog API.

    Parameters

    Returns Promise<GetCatalogResponse>

    GetCatalogResponse

getCatalogPrivateEndpoint

getConnection

  • Gets a specific data asset connection by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConnection API.

    Parameters

    Returns Promise<GetConnectionResponse>

    GetConnectionResponse

getCustomProperty

  • Gets a specific custom property for the given key within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCustomProperty API.

    Parameters

    Returns Promise<GetCustomPropertyResponse>

    GetCustomPropertyResponse

getDataAsset

  • Gets a specific data asset for the given key within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDataAsset API.

    Parameters

    Returns Promise<GetDataAssetResponse>

    GetDataAssetResponse

getDataAssetTag

  • Gets a specific data asset tag by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDataAssetTag API.

    Parameters

    Returns Promise<GetDataAssetTagResponse>

    GetDataAssetTagResponse

getEntity

  • Gets a specific data entity by key for a data asset. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetEntity API.

    Parameters

    Returns Promise<GetEntityResponse>

    GetEntityResponse

getEntityTag

  • Gets a specific entity tag by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetEntityTag API.

    Parameters

    Returns Promise<GetEntityTagResponse>

    GetEntityTagResponse

getFolder

  • Gets a specific data asset folder by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetFolder API.

    Parameters

    Returns Promise<GetFolderResponse>

    GetFolderResponse

getFolderTag

  • Gets a specific folder tag by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetFolderTag API.

    Parameters

    Returns Promise<GetFolderTagResponse>

    GetFolderTagResponse

getGlossary

  • Gets a specific glossary by key within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetGlossary API.

    Parameters

    Returns Promise<GetGlossaryResponse>

    GetGlossaryResponse

getJob

  • Gets a specific job by key within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJob API.

    Parameters

    Returns Promise<GetJobResponse>

    GetJobResponse

getJobDefinition

  • Gets a specific job definition by key within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJobDefinition API.

    Parameters

    Returns Promise<GetJobDefinitionResponse>

    GetJobDefinitionResponse

getJobExecution

  • Gets a specific job execution by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJobExecution API.

    Parameters

    Returns Promise<GetJobExecutionResponse>

    GetJobExecutionResponse

getJobLog

  • Gets a specific job log by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJobLog API.

    Parameters

    Returns Promise<GetJobLogResponse>

    GetJobLogResponse

getJobMetrics

  • Gets a specific job metric by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJobMetrics API.

    Parameters

    Returns Promise<GetJobMetricsResponse>

    GetJobMetricsResponse

getMetastore

  • Gets a metastore by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMetastore API.

    Parameters

    Returns Promise<GetMetastoreResponse>

    GetMetastoreResponse

getNamespace

  • Gets a specific namespace for the given key within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetNamespace API.

    Parameters

    Returns Promise<GetNamespaceResponse>

    GetNamespaceResponse

getPattern

  • Gets a specific pattern for the given key within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPattern API.

    Parameters

    Returns Promise<GetPatternResponse>

    GetPatternResponse

getTerm

  • Gets a specific glossary term by key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTerm API.

    Parameters

    Returns Promise<GetTermResponse>

    GetTermResponse

getTermRelationship

getType

  • Gets a specific type by key within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetType API.

    Parameters

    Returns Promise<GetTypeResponse>

    GetTypeResponse

getWaiters

getWorkRequest

  • Gets the status of the work request with the given OCID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

importConnection

importDataAsset

importGlossary

  • Import the glossary and the terms from csv or json files and return the imported glossary resource. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ImportGlossary API.

    Parameters

    Returns Promise<ImportGlossaryResponse>

    ImportGlossaryResponse

listAggregatedPhysicalEntities

listAllCatalogPrivateEndpoints

  • NOTE: This function is deprecated in favor of listCatalogPrivateEndpointsRecordIterator function. Creates a new async iterator which will iterate over the models.CatalogPrivateEndpointSummary objects contained in responses from the listCatalogPrivateEndpoints operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CatalogPrivateEndpointSummary>

listAllCatalogPrivateEndpointsResponses

listAllCatalogs

  • NOTE: This function is deprecated in favor of listCatalogsRecordIterator function. Creates a new async iterator which will iterate over the models.CatalogSummary objects contained in responses from the listCatalogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CatalogSummary>

listAllCatalogsResponses

  • NOTE: This function is deprecated in favor of listCatalogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCatalogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCatalogsResponse>

listAllMetastores

  • NOTE: This function is deprecated in favor of listMetastoresRecordIterator function. Creates a new async iterator which will iterate over the models.MetastoreSummary objects contained in responses from the listMetastores operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<MetastoreSummary>

listAllMetastoresResponses

  • NOTE: This function is deprecated in favor of listMetastoresResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listMetastores operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListMetastoresResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLog objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLog>

listAllWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequest objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequest>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listAttributeTags

  • Returns a list of all tags for an entity attribute. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAttributeTags API.

    Parameters

    Returns Promise<ListAttributeTagsResponse>

    ListAttributeTagsResponse

listAttributes

  • Returns a list of all attributes of an data entity. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAttributes API.

    Parameters

    Returns Promise<ListAttributesResponse>

    ListAttributesResponse

listCatalogPrivateEndpoints

listCatalogPrivateEndpointsRecordIterator

listCatalogPrivateEndpointsResponseIterator

listCatalogs

  • Returns a list of all the data catalogs in the specified compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCatalogs API.

    Parameters

    Returns Promise<ListCatalogsResponse>

    ListCatalogsResponse

listCatalogsRecordIterator

  • Creates a new async iterator which will iterate over the models.CatalogSummary objects contained in responses from the listCatalogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CatalogSummary>

listCatalogsResponseIterator

listConnections

  • Returns a list of all Connections for a data asset. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListConnections API.

    Parameters

    Returns Promise<ListConnectionsResponse>

    ListConnectionsResponse

listCustomProperties

  • Returns a list of custom properties within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCustomProperties API.

    Parameters

    Returns Promise<ListCustomPropertiesResponse>

    ListCustomPropertiesResponse

listDataAssetTags

  • Returns a list of all tags for a data asset. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDataAssetTags API.

    Parameters

    Returns Promise<ListDataAssetTagsResponse>

    ListDataAssetTagsResponse

listDataAssets

  • Returns a list of data assets within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDataAssets API.

    Parameters

    Returns Promise<ListDataAssetsResponse>

    ListDataAssetsResponse

listDerivedLogicalEntities

listEntities

  • Returns a list of all entities of a data asset. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListEntities API.

    Parameters

    Returns Promise<ListEntitiesResponse>

    ListEntitiesResponse

listEntityTags

  • Returns a list of all tags for a data entity. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListEntityTags API.

    Parameters

    Returns Promise<ListEntityTagsResponse>

    ListEntityTagsResponse

listFolderTags

  • Returns a list of all tags for a folder. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFolderTags API.

    Parameters

    Returns Promise<ListFolderTagsResponse>

    ListFolderTagsResponse

listFolders

  • Returns a list of all folders. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFolders API.

    Parameters

    Returns Promise<ListFoldersResponse>

    ListFoldersResponse

listGlossaries

  • Returns a list of all glossaries within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListGlossaries API.

    Parameters

    Returns Promise<ListGlossariesResponse>

    ListGlossariesResponse

listJobDefinitions

  • Returns a list of job definitions within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobDefinitions API.

    Parameters

    Returns Promise<ListJobDefinitionsResponse>

    ListJobDefinitionsResponse

listJobExecutions

  • Returns a list of job executions for a job. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobExecutions API.

    Parameters

    Returns Promise<ListJobExecutionsResponse>

    ListJobExecutionsResponse

listJobLogs

  • Returns a list of job logs. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobLogs API.

    Parameters

    Returns Promise<ListJobLogsResponse>

    ListJobLogsResponse

listJobMetrics

  • Returns a list of job metrics. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobMetrics API.

    Parameters

    Returns Promise<ListJobMetricsResponse>

    ListJobMetricsResponse

listJobs

  • Returns a list of jobs within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListJobs API.

    Parameters

    Returns Promise<ListJobsResponse>

    ListJobsResponse

listMetastores

  • Returns a list of all metastores in the specified compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMetastores API.

    Parameters

    Returns Promise<ListMetastoresResponse>

    ListMetastoresResponse

listMetastoresRecordIterator

  • Creates a new async iterator which will iterate over the models.MetastoreSummary objects contained in responses from the listMetastores operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<MetastoreSummary>

listMetastoresResponseIterator

listNamespaces

  • Returns a list of namespaces within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListNamespaces API.

    Parameters

    Returns Promise<ListNamespacesResponse>

    ListNamespacesResponse

listPatterns

  • Returns a list of patterns within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPatterns API.

    Parameters

    Returns Promise<ListPatternsResponse>

    ListPatternsResponse

listRules

  • Returns a list of all rules of a data entity. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRules API.

    Parameters

    Returns Promise<ListRulesResponse>

    ListRulesResponse

listTags

  • Returns a list of all user created tags in the system. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTags API.

    Parameters

    Returns Promise<ListTagsResponse>

    ListTagsResponse

listTermRelationships

listTerms

  • Returns a list of all terms within a glossary. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTerms API.

    Parameters

    Returns Promise<ListTermsResponse>

    ListTermsResponse

listTypes

  • Returns a list of all types within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTypes API.

    Parameters

    Returns Promise<ListTypesResponse>

    ListTypesResponse

listWorkRequestErrors

  • Returns a (paginated) list of errors for a given work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestErrorsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

  • Returns a (paginated) list of logs for a given work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequestLogsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestLog objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLog>

listWorkRequestLogsResponseIterator

listWorkRequests

  • Lists the work requests in a compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequest objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequest>

listWorkRequestsResponseIterator

objectStats

  • Returns stats on objects by type in the repository. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ObjectStats API.

    Parameters

    Returns Promise<ObjectStatsResponse>

    ObjectStatsResponse

parseConnection

processRecommendation

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ProcessRecommendation API.

    Parameters

    Returns Promise<ProcessRecommendationResponse>

    ProcessRecommendationResponse

recommendations

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use Recommendations API.

    Parameters

    Returns Promise<RecommendationsResponse>

    RecommendationsResponse

removeCatalogLock

removeCatalogPrivateEndpointLock

removeDataSelectorPatterns

removeMetastoreLock

searchCriteria

  • Returns a list of search results within a data catalog. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SearchCriteria API.

    Parameters

    Returns Promise<SearchCriteriaResponse>

    SearchCriteriaResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

suggestMatches

  • Returns a list of potential string matches for a given input string. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SuggestMatches API.

    Parameters

    Returns Promise<SuggestMatchesResponse>

    SuggestMatchesResponse

synchronousExportDataAsset

testConnection

  • Test the connection by connecting to the data asset using credentials in the metadata. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use TestConnection API.

    Parameters

    Returns Promise<TestConnectionResponse>

    TestConnectionResponse

updateAttribute

updateCatalog

updateCatalogPrivateEndpoint

updateConnection

updateCustomProperty

updateDataAsset

updateEntity

updateFolder

updateGlossary

updateJob

  • Updates a specific job identified by the given key. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateJob API.

    Parameters

    Returns Promise<UpdateJobResponse>

    UpdateJobResponse

updateJobDefinition

updateMetastore

updateNamespace

updatePattern

updateTerm

updateTermRelationship

uploadCredentials

users

  • Returns active users in the system. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use Users API.

    Parameters

    Returns Promise<UsersResponse>

    UsersResponse

validateConnection

  • Validate connection by connecting to the data asset using credentials in metadata. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ValidateConnection API.

    Parameters

    Returns Promise<ValidateConnectionResponse>

    ValidateConnectionResponse

validatePattern

  • Validate pattern by deriving file groups representing logical entities using the expression This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ValidatePattern API.

    Parameters

    Returns Promise<ValidatePatternResponse>

    ValidatePatternResponse