DataCatalogClient¶

class oci.data_catalog.DataCatalogClient(config, **kwargs)¶

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](https://docs.oracle.com/iaas/data-catalog/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_catalog_lock`(catalog_id, …)	Adds a lock to a Catalog resource.
`add_catalog_private_endpoint_lock`(…)	Adds a lock to a CatalogPrivateEndpoint resource.
`add_data_selector_patterns`(catalog_id, …)	Add data selector pattern to the data asset.
`add_metastore_lock`(metastore_id, …)	Adds a lock to a Metastore resource.
`associate_custom_property`(catalog_id, …)	Associate the custom property for the given type
`asynchronous_export_data_asset`(catalog_id, …)	Export technical objects from a Data Asset in Excel format.
`asynchronous_export_glossary`(catalog_id, …)	Exports the contents of a glossary in Excel format.
`attach_catalog_private_endpoint`(…)	Attaches a private reverse connection endpoint resource to a data catalog resource.
`change_catalog_compartment`(…)	Moves a resource into a different compartment.
`change_catalog_private_endpoint_compartment`(…)	Moves a resource into a different compartment.
`change_metastore_compartment`(…)	Moves a resource into a different compartment.
`create_attribute`(catalog_id, data_asset_key, …)	Creates a new entity attribute.
`create_attribute_tag`(catalog_id, …)	Creates a new entity attribute tag.
`create_catalog`(create_catalog_details, **kwargs)	Creates a new data catalog instance that includes a console and an API URL for managing metadata operations.
`create_catalog_private_endpoint`(…)	Create a new private reverse connection endpoint.
`create_connection`(catalog_id, …)	Creates a new connection.
`create_custom_property`(catalog_id, …)	Create a new Custom Property
`create_data_asset`(catalog_id, …)	Create a new data asset.
`create_data_asset_tag`(catalog_id, …)	Creates a new data asset tag.
`create_entity`(catalog_id, data_asset_key, …)	Creates a new data entity.
`create_entity_tag`(catalog_id, …)	Creates a new entity tag.
`create_folder`(catalog_id, data_asset_key, …)	Creates a new folder.
`create_folder_tag`(catalog_id, …)	Creates a new folder tag.
`create_glossary`(catalog_id, …)	Creates a new glossary.
`create_job`(catalog_id, create_job_details, …)	Creates a new job.
`create_job_definition`(catalog_id, …)	Creates a new job definition.
`create_job_execution`(catalog_id, job_key, …)	Creates a new job execution.
`create_metastore`(create_metastore_details, …)	Creates a new metastore.
`create_namespace`(catalog_id, …)	Create a new Namespace to be used by a custom property
`create_pattern`(catalog_id, …)	Create a new pattern.
`create_term`(catalog_id, glossary_key, …)	Create a new term within a glossary.
`create_term_relationship`(catalog_id, …)	Creates a new term relationship for this term within a glossary.
`delete_attribute`(catalog_id, data_asset_key, …)	Deletes a specific entity attribute.
`delete_attribute_tag`(catalog_id, …)	Deletes a specific entity attribute tag.
`delete_catalog`(catalog_id, **kwargs)	Deletes a data catalog resource by identifier.
`delete_catalog_private_endpoint`(…)	Deletes a private reverse connection endpoint by identifier.
`delete_connection`(catalog_id, …)	Deletes a specific connection of a data asset.
`delete_custom_property`(catalog_id, …)	Deletes a specific custom property identified by it’s key.
`delete_data_asset`(catalog_id, …)	Deletes a specific data asset identified by it’s key.
`delete_data_asset_tag`(catalog_id, …)	Deletes a specific data asset tag.
`delete_entity`(catalog_id, data_asset_key, …)	Deletes a specific data entity.
`delete_entity_tag`(catalog_id, …)	Deletes a specific entity tag.
`delete_folder`(catalog_id, data_asset_key, …)	Deletes a specific folder of a data asset identified by it’s key.
`delete_folder_tag`(catalog_id, …)	Deletes a specific folder tag.
`delete_glossary`(catalog_id, glossary_key, …)	Deletes a specific glossary identified by it’s key.
`delete_job`(catalog_id, job_key, **kwargs)	Deletes a specific job identified by it’s key.
`delete_job_definition`(catalog_id, …)	Deletes a specific job definition identified by it’s key.
`delete_metastore`(metastore_id, **kwargs)	Deletes a metastore resource by identifier.
`delete_namespace`(catalog_id, namespace_id, …)	Deletes a specific Namespace identified by it’s key.
`delete_pattern`(catalog_id, pattern_key, **kwargs)	Deletes a specific pattern identified by it’s key.
`delete_term`(catalog_id, glossary_key, …)	Deletes a specific glossary term.
`delete_term_relationship`(catalog_id, …)	Deletes a specific glossary term relationship.
`detach_catalog_private_endpoint`(…)	Detaches a private reverse connection endpoint resource to a data catalog resource.
`disassociate_custom_property`(catalog_id, …)	Remove the custom property for the given type
`expand_tree_for_glossary`(catalog_id, …)	Returns the fully expanded tree hierarchy of parent and child terms in this glossary.
`export_glossary`(catalog_id, glossary_key, …)	Export the glossary and the terms and return the exported glossary as csv or json.
`fetch_entity_lineage`(catalog_id, …)	Returns lineage for a given entity object.
`get_attribute`(catalog_id, data_asset_key, …)	Gets a specific entity attribute by key.
`get_attribute_tag`(catalog_id, …)	Gets a specific entity attribute tag by key.
`get_catalog`(catalog_id, **kwargs)	Gets a data catalog by identifier.
`get_catalog_private_endpoint`(…)	Gets a specific private reverse connection by identifier.
`get_connection`(catalog_id, data_asset_key, …)	Gets a specific data asset connection by key.
`get_custom_property`(catalog_id, …)	Gets a specific custom property for the given key within a data catalog.
`get_data_asset`(catalog_id, data_asset_key, …)	Gets a specific data asset for the given key within a data catalog.
`get_data_asset_tag`(catalog_id, …)	Gets a specific data asset tag by key.
`get_entity`(catalog_id, data_asset_key, …)	Gets a specific data entity by key for a data asset.
`get_entity_tag`(catalog_id, data_asset_key, …)	Gets a specific entity tag by key.
`get_folder`(catalog_id, data_asset_key, …)	Gets a specific data asset folder by key.
`get_folder_tag`(catalog_id, data_asset_key, …)	Gets a specific folder tag by key.
`get_glossary`(catalog_id, glossary_key, **kwargs)	Gets a specific glossary by key within a data catalog.
`get_job`(catalog_id, job_key, **kwargs)	Gets a specific job by key within a data catalog.
`get_job_definition`(catalog_id, …)	Gets a specific job definition by key within a data catalog.
`get_job_execution`(catalog_id, job_key, …)	Gets a specific job execution by key.
`get_job_log`(catalog_id, job_key, …)	Gets a specific job log by key.
`get_job_metrics`(catalog_id, job_key, …)	Gets a specific job metric by key.
`get_metastore`(metastore_id, **kwargs)	Gets a metastore by identifier.
`get_namespace`(catalog_id, namespace_id, **kwargs)	Gets a specific namespace for the given key within a data catalog.
`get_pattern`(catalog_id, pattern_key, **kwargs)	Gets a specific pattern for the given key within a data catalog.
`get_term`(catalog_id, glossary_key, term_key, …)	Gets a specific glossary term by key.
`get_term_relationship`(catalog_id, …)	Gets a specific glossary term relationship by key.
`get_type`(catalog_id, type_key, **kwargs)	Gets a specific type by key within a data catalog.
`get_work_request`(work_request_id, **kwargs)	Gets the status of the work request with the given OCID.
`import_connection`(catalog_id, …)	Import new connection for this data asset.
`import_data_asset`(catalog_id, …)	Import technical objects to a Data Asset
`import_glossary`(catalog_id, glossary_key, …)	Import the glossary and the terms from csv or json files and return the imported glossary resource.
`import_lineage`(catalog_id, data_asset_key, …)	Imports lineage metadata.
`list_aggregated_physical_entities`(…)	List the physical entities aggregated by this logical entity.
`list_attribute_tags`(catalog_id, …)	Returns a list of all tags for an entity attribute.
`list_attributes`(catalog_id, data_asset_key, …)	Returns a list of all attributes of an data entity.
`list_catalog_private_endpoints`(…)	Returns a list of all the catalog private endpoints in the specified compartment.
`list_catalogs`(compartment_id, **kwargs)	Returns a list of all the data catalogs in the specified compartment.
`list_connections`(catalog_id, data_asset_key, …)	Returns a list of all Connections for a data asset.
`list_custom_properties`(catalog_id, …)	Returns a list of custom properties within a data catalog.
`list_data_asset_tags`(catalog_id, …)	Returns a list of all tags for a data asset.
`list_data_assets`(catalog_id, **kwargs)	Returns a list of data assets within a data catalog.
`list_derived_logical_entities`(catalog_id, …)	List logical entities derived from this pattern.
`list_entities`(catalog_id, data_asset_key, …)	Returns a list of all entities of a data asset.
`list_entity_tags`(catalog_id, data_asset_key, …)	Returns a list of all tags for a data entity.
`list_folder_tags`(catalog_id, data_asset_key, …)	Returns a list of all tags for a folder.
`list_folders`(catalog_id, data_asset_key, …)	Returns a list of all folders.
`list_glossaries`(catalog_id, **kwargs)	Returns a list of all glossaries within a data catalog.
`list_job_definitions`(catalog_id, **kwargs)	Returns a list of job definitions within a data catalog.
`list_job_executions`(catalog_id, job_key, …)	Returns a list of job executions for a job.
`list_job_logs`(catalog_id, job_key, …)	Returns a list of job logs.
`list_job_metrics`(catalog_id, job_key, …)	Returns a list of job metrics.
`list_jobs`(catalog_id, **kwargs)	Returns a list of jobs within a data catalog.
`list_metastores`(compartment_id, **kwargs)	Returns a list of all metastores in the specified compartment.
`list_namespaces`(catalog_id, **kwargs)	Returns a list of namespaces within a data catalog.
`list_patterns`(catalog_id, **kwargs)	Returns a list of patterns within a data catalog.
`list_rules`(catalog_id, data_asset_key, …)	Returns a list of all rules of a data entity.
`list_tags`(catalog_id, **kwargs)	Returns a list of all user created tags in the system.
`list_term_relationships`(catalog_id, …)	Returns a list of all term relationships within a glossary.
`list_terms`(catalog_id, glossary_key, **kwargs)	Returns a list of all terms within a glossary.
`list_types`(catalog_id, **kwargs)	Returns a list of all types within a data catalog.
`list_work_request_errors`(work_request_id, …)	Returns a (paginated) list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Returns a (paginated) list of logs for a given work request.
`list_work_requests`(compartment_id, **kwargs)	Lists the work requests in a compartment.
`object_stats`(catalog_id, **kwargs)	Returns stats on objects by type in the repository.
`parse_connection`(catalog_id, data_asset_key, …)	Parse data asset references through connections from this data asset.
`process_recommendation`(catalog_id, …)	Act on a recommendation.
`recommendations`(catalog_id, …)	Returns a list of recommendations for the given object and recommendation type.
`remove_catalog_lock`(catalog_id, …)	Removes a lock from a Catalog resource.
`remove_catalog_private_endpoint_lock`(…)	Removes a lock from a CatalogPrivateEndpoint resource.
`remove_data_selector_patterns`(catalog_id, …)	Remove data selector pattern from the data asset.
`remove_metastore_lock`(metastore_id, …)	Removes a lock from a Metastore resource.
`search_criteria`(catalog_id, **kwargs)	Returns a list of search results within a data catalog.
`suggest_matches`(catalog_id, input_text, **kwargs)	Returns a list of potential string matches for a given input string.
`synchronous_export_data_asset`(catalog_id, …)	Export technical objects from a Data Asset
`test_connection`(catalog_id, data_asset_key, …)	Test the connection by connecting to the data asset using credentials in the metadata.
`update_attribute`(catalog_id, data_asset_key, …)	Updates a specific data asset attribute.
`update_catalog`(catalog_id, …)	Updates the data catalog.
`update_catalog_private_endpoint`(…)	Updates the private reverse connection endpoint.
`update_connection`(catalog_id, …)	Updates a specific connection of a data asset.
`update_custom_property`(catalog_id, …)	Updates a specific custom property identified by the given key.
`update_data_asset`(catalog_id, …)	Updates a specific data asset identified by the given key.
`update_entity`(catalog_id, data_asset_key, …)	Updates a specific data entity.
`update_folder`(catalog_id, data_asset_key, …)	Updates a specific folder of a data asset.
`update_glossary`(catalog_id, glossary_key, …)	Updates a specific glossary identified by the given key.
`update_job`(catalog_id, job_key, …)	Updates a specific job identified by the given key.
`update_job_definition`(catalog_id, …)	Update a specific job definition identified by the given key.
`update_metastore`(metastore_id, …)	Updates a metastore resource by identifier.
`update_namespace`(catalog_id, namespace_id, …)	Updates a specific namespace identified by the given key.
`update_pattern`(catalog_id, pattern_key, …)	Updates a specific pattern identified by the given key.
`update_term`(catalog_id, glossary_key, …)	Updates a specific glossary term.
`update_term_relationship`(catalog_id, …)	Updates a specific glossary term relationship.
`upload_credentials`(catalog_id, …)	Upload connection credentails and metadata for this connection.
`users`(catalog_id, **kwargs)	Returns active users in the system.
`validate_connection`(catalog_id, …)	Validate connection by connecting to the data asset using credentials in metadata.
`validate_pattern`(catalog_id, pattern_key, …)	Validate pattern by deriving file groups representing logical entities using the expression

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

add_catalog_lock(catalog_id, add_resource_lock_details, **kwargs)¶

Adds a lock to a Catalog resource.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. add_resource_lock_details (oci.data_catalog.models.AddResourceLockDetails) – (required) AddResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Catalog`
Return type:	`Response`
Example:

Click here to see an example of how to use add_catalog_lock API.

add_catalog_private_endpoint_lock(catalog_private_endpoint_id, add_resource_lock_details, **kwargs)¶

Adds a lock to a CatalogPrivateEndpoint resource.

Parameters:	catalog_private_endpoint_id (str) – (required) Unique private reverse connection identifier. add_resource_lock_details (oci.data_catalog.models.AddResourceLockDetails) – (required) AddResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CatalogPrivateEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use add_catalog_private_endpoint_lock API.

add_data_selector_patterns(catalog_id, data_asset_key, data_selector_pattern_details, **kwargs)¶

Add data selector pattern to the data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. data_selector_pattern_details (oci.data_catalog.models.DataSelectorPatternDetails) – (required) The information used to add the patterns for deriving logical entities. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use add_data_selector_patterns API.

add_metastore_lock(metastore_id, add_resource_lock_details, **kwargs)¶

Adds a lock to a Metastore resource.

Parameters:	metastore_id (str) – (required) The metastore’s OCID. add_resource_lock_details (oci.data_catalog.models.AddResourceLockDetails) – (required) AddResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Metastore`
Return type:	`Response`
Example:

Click here to see an example of how to use add_metastore_lock API.

associate_custom_property(catalog_id, type_key, associate_custom_property_details, **kwargs)¶

Associate the custom property for the given type

Parameters:	catalog_id (str) – (required) Unique catalog identifier. type_key (str) – (required) Unique type key. associate_custom_property_details (oci.data_catalog.models.TypeCustomPropertyDetails) – (required) The information used to associate the custom property for the type. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Type`
Return type:	`Response`
Example:

Click here to see an example of how to use associate_custom_property API.

asynchronous_export_data_asset(catalog_id, data_asset_key, asynchronous_export_data_asset_details, export_type, **kwargs)¶

Export technical objects from a Data Asset in Excel format. Returns details about the job which actually performs the export.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. asynchronous_export_data_asset_details (oci.data_catalog.models.AsynchronousExportDataAssetDetails) – (required) Details needed by the Data Asset export request. export_type (oci.data_catalog.models.list[str]) – (required) Type of export. Allowed values are: “CUSTOM_PROPERTY_VALUES”, “ALL” opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AsynchronousExportDataAssetResult`
Return type:	`Response`
Example:

Click here to see an example of how to use asynchronous_export_data_asset API.

asynchronous_export_glossary(catalog_id, glossary_key, asynchronous_export_glossary_details, **kwargs)¶

Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. asynchronous_export_glossary_details (oci.data_catalog.models.AsynchronousExportGlossaryDetails) – (required) Details needed by the glossary export request. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AsynchronousExportGlossaryResult`
Return type:	`Response`
Example:

Click here to see an example of how to use asynchronous_export_glossary API.

attach_catalog_private_endpoint(attach_catalog_private_endpoint_details, catalog_id, **kwargs)¶

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:	attach_catalog_private_endpoint_details (oci.data_catalog.models.AttachCatalogPrivateEndpointDetails) – (required) Details for private reverse connection endpoint to be used for attachment. catalog_id (str) – (required) Unique catalog identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use attach_catalog_private_endpoint API.

change_catalog_compartment(change_catalog_compartment_details, catalog_id, **kwargs)¶

Moves a resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

Parameters:	change_catalog_compartment_details (oci.data_catalog.models.ChangeCatalogCompartmentDetails) – (required) Details for the target compartment. catalog_id (str) – (required) Unique catalog identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_catalog_compartment API.

change_catalog_private_endpoint_compartment(change_catalog_private_endpoint_compartment_details, catalog_private_endpoint_id, **kwargs)¶

Moves a resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

Parameters:	change_catalog_private_endpoint_compartment_details (oci.data_catalog.models.ChangeCatalogPrivateEndpointCompartmentDetails) – (required) Details for the target compartment. catalog_private_endpoint_id (str) – (required) Unique private reverse connection identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_catalog_private_endpoint_compartment API.

change_metastore_compartment(change_metastore_compartment_details, metastore_id, **kwargs)¶

Moves a resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

Parameters:	change_metastore_compartment_details (oci.data_catalog.models.ChangeMetastoreCompartmentDetails) – (required) Information about a change in metastore compartment. metastore_id (str) – (required) The metastore’s OCID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_metastore_compartment API.

create_attribute(catalog_id, data_asset_key, entity_key, create_attribute_details, **kwargs)¶

Creates a new entity attribute.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. create_attribute_details (oci.data_catalog.models.CreateAttributeDetails) – (required) The information used to create an entity attribute. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Attribute`
Return type:	`Response`
Example:

Click here to see an example of how to use create_attribute API.

create_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, create_attribute_tag_details, **kwargs)¶

Creates a new entity attribute tag.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. attribute_key (str) – (required) Unique attribute key. create_attribute_tag_details (oci.data_catalog.models.CreateTagDetails) – (required) The information used to create an entity attribute tag. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AttributeTag`
Return type:	`Response`
Example:

Click here to see an example of how to use create_attribute_tag API.

create_catalog(create_catalog_details, **kwargs)¶

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:	create_catalog_details (oci.data_catalog.models.CreateCatalogDetails) – (required) Details for the new data catalog. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_catalog API.

create_catalog_private_endpoint(create_catalog_private_endpoint_details, **kwargs)¶

Create a new private reverse connection endpoint.

Parameters:	create_catalog_private_endpoint_details (oci.data_catalog.models.CreateCatalogPrivateEndpointDetails) – (required) The information used to create the private reverse connection. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_catalog_private_endpoint API.

create_connection(catalog_id, data_asset_key, create_connection_details, **kwargs)¶

Creates a new connection.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. create_connection_details (oci.data_catalog.models.CreateConnectionDetails) – (required) The information used to create the connection. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use create_connection API.

create_custom_property(catalog_id, namespace_id, create_custom_property_details, **kwargs)¶

Create a new Custom Property

Parameters:	catalog_id (str) – (required) Unique catalog identifier. namespace_id (str) – (required) Unique namespace identifier. create_custom_property_details (oci.data_catalog.models.CreateCustomPropertyDetails) – (required) The information used to create the Custom Property. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CustomProperty`
Return type:	`Response`
Example:

Click here to see an example of how to use create_custom_property API.

create_data_asset(catalog_id, create_data_asset_details, **kwargs)¶

Create a new data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. create_data_asset_details (oci.data_catalog.models.CreateDataAssetDetails) – (required) The information used to create the data asset. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use create_data_asset API.

create_data_asset_tag(catalog_id, data_asset_key, create_data_asset_tag_details, **kwargs)¶

Creates a new data asset tag.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. create_data_asset_tag_details (oci.data_catalog.models.CreateTagDetails) – (required) The information used to create the data asset tag. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAssetTag`
Return type:	`Response`
Example:

Click here to see an example of how to use create_data_asset_tag API.

create_entity(catalog_id, data_asset_key, create_entity_details, **kwargs)¶

Creates a new data entity.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. create_entity_details (oci.data_catalog.models.CreateEntityDetails) – (required) The information used to create the data entity. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Entity`
Return type:	`Response`
Example:

Click here to see an example of how to use create_entity API.

create_entity_tag(catalog_id, data_asset_key, entity_key, create_entity_tag_details, **kwargs)¶

Creates a new entity tag.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. create_entity_tag_details (oci.data_catalog.models.CreateTagDetails) – (required) The information used to create the entity tag. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EntityTag`
Return type:	`Response`
Example:

Click here to see an example of how to use create_entity_tag API.

create_folder(catalog_id, data_asset_key, create_folder_details, **kwargs)¶

Creates a new folder.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. create_folder_details (oci.data_catalog.models.CreateFolderDetails) – (required) The information used to create the folder. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Folder`
Return type:	`Response`
Example:

Click here to see an example of how to use create_folder API.

create_folder_tag(catalog_id, data_asset_key, folder_key, create_folder_tag_details, **kwargs)¶

Creates a new folder tag.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. folder_key (str) – (required) Unique folder key. create_folder_tag_details (oci.data_catalog.models.CreateTagDetails) – (required) The information used to create the folder tag. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FolderTag`
Return type:	`Response`
Example:

Click here to see an example of how to use create_folder_tag API.

create_glossary(catalog_id, create_glossary_details, **kwargs)¶

Creates a new glossary.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. create_glossary_details (oci.data_catalog.models.CreateGlossaryDetails) – (required) The information used to create the glossary. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Glossary`
Return type:	`Response`
Example:

Click here to see an example of how to use create_glossary API.

create_job(catalog_id, create_job_details, **kwargs)¶

Creates a new job.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. create_job_details (oci.data_catalog.models.CreateJobDetails) – (required) The information used to create the job. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Job`
Return type:	`Response`
Example:

Click here to see an example of how to use create_job API.

create_job_definition(catalog_id, create_job_definition_details, **kwargs)¶

Creates a new job definition.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. create_job_definition_details (oci.data_catalog.models.CreateJobDefinitionDetails) – (required) The information used to create the job definition. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobDefinition`
Return type:	`Response`
Example:

Click here to see an example of how to use create_job_definition API.

create_job_execution(catalog_id, job_key, create_job_execution_details, **kwargs)¶

Creates a new job execution.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. create_job_execution_details (oci.data_catalog.models.CreateJobExecutionDetails) – (required) The information used to create the job execution. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobExecution`
Return type:	`Response`
Example:

Click here to see an example of how to use create_job_execution API.

create_metastore(create_metastore_details, **kwargs)¶

Creates a new metastore.

Parameters:	create_metastore_details (oci.data_catalog.models.CreateMetastoreDetails) – (required) Information about a new metastore to be created. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_metastore API.

create_namespace(catalog_id, create_namespace_details, **kwargs)¶

Create a new Namespace to be used by a custom property

Parameters:	catalog_id (str) – (required) Unique catalog identifier. create_namespace_details (oci.data_catalog.models.CreateNamespaceDetails) – (required) The information used to create the Namespace. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Namespace`
Return type:	`Response`
Example:

Click here to see an example of how to use create_namespace API.

create_pattern(catalog_id, create_pattern_details, **kwargs)¶

Create a new pattern.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. create_pattern_details (oci.data_catalog.models.CreatePatternDetails) – (required) The information used to create the pattern. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Pattern`
Return type:	`Response`
Example:

Click here to see an example of how to use create_pattern API.

create_term(catalog_id, glossary_key, create_term_details, **kwargs)¶

Create a new term within a glossary.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. create_term_details (oci.data_catalog.models.CreateTermDetails) – (required) The information used to create the term. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Term`
Return type:	`Response`
Example:

Click here to see an example of how to use create_term API.

create_term_relationship(catalog_id, glossary_key, term_key, create_term_relationship_details, **kwargs)¶

Creates a new term relationship for this term within a glossary.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. term_key (str) – (required) Unique glossary term key. create_term_relationship_details (oci.data_catalog.models.CreateTermRelationshipDetails) – (required) The information used to create the term relationship. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TermRelationship`
Return type:	`Response`
Example:

Click here to see an example of how to use create_term_relationship API.

delete_attribute(catalog_id, data_asset_key, entity_key, attribute_key, **kwargs)¶

Deletes a specific entity attribute.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. attribute_key (str) – (required) Unique attribute key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_attribute API.

delete_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, tag_key, **kwargs)¶

Deletes a specific entity attribute tag.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. attribute_key (str) – (required) Unique attribute key. tag_key (str) – (required) Unique tag key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_attribute_tag API.

delete_catalog(catalog_id, **kwargs)¶

Deletes a data catalog resource by identifier.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_catalog API.

delete_catalog_private_endpoint(catalog_private_endpoint_id, **kwargs)¶

Deletes a private reverse connection endpoint by identifier.

Parameters:	catalog_private_endpoint_id (str) – (required) Unique private reverse connection identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_catalog_private_endpoint API.

delete_connection(catalog_id, data_asset_key, connection_key, **kwargs)¶

Deletes a specific connection of a data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. connection_key (str) – (required) Unique connection key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_connection API.

delete_custom_property(catalog_id, namespace_id, custom_property_key, **kwargs)¶

Deletes a specific custom property identified by it’s key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. namespace_id (str) – (required) Unique namespace identifier. custom_property_key (str) – (required) Unique Custom Property key if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_custom_property API.

delete_data_asset(catalog_id, data_asset_key, **kwargs)¶

Deletes a specific data asset identified by it’s key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_data_asset API.

delete_data_asset_tag(catalog_id, data_asset_key, tag_key, **kwargs)¶

Deletes a specific data asset tag.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. tag_key (str) – (required) Unique tag key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_data_asset_tag API.

delete_entity(catalog_id, data_asset_key, entity_key, **kwargs)¶

Deletes a specific data entity.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_entity API.

delete_entity_tag(catalog_id, data_asset_key, entity_key, tag_key, **kwargs)¶

Deletes a specific entity tag.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. tag_key (str) – (required) Unique tag key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_entity_tag API.

delete_folder(catalog_id, data_asset_key, folder_key, **kwargs)¶

Deletes a specific folder of a data asset identified by it’s key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. folder_key (str) – (required) Unique folder key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_folder API.

delete_folder_tag(catalog_id, data_asset_key, folder_key, tag_key, **kwargs)¶

Deletes a specific folder tag.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. folder_key (str) – (required) Unique folder key. tag_key (str) – (required) Unique tag key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_folder_tag API.

delete_glossary(catalog_id, glossary_key, **kwargs)¶

Deletes a specific glossary identified by it’s key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_glossary API.

delete_job(catalog_id, job_key, **kwargs)¶

Deletes a specific job identified by it’s key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_job API.

delete_job_definition(catalog_id, job_definition_key, **kwargs)¶

Deletes a specific job definition identified by it’s key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_definition_key (str) – (required) Unique job definition key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_job_definition API.

delete_metastore(metastore_id, **kwargs)¶

Deletes a metastore resource by identifier.

Parameters:	metastore_id (str) – (required) The metastore’s OCID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_metastore API.

delete_namespace(catalog_id, namespace_id, **kwargs)¶

Deletes a specific Namespace identified by it’s key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. namespace_id (str) – (required) Unique namespace identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_namespace API.

delete_pattern(catalog_id, pattern_key, **kwargs)¶

Deletes a specific pattern identified by it’s key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. pattern_key (str) – (required) Unique pattern key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_pattern API.

delete_term(catalog_id, glossary_key, term_key, **kwargs)¶

Deletes a specific glossary term.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. term_key (str) – (required) Unique glossary term key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_term API.

delete_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, **kwargs)¶

Deletes a specific glossary term relationship.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. term_key (str) – (required) Unique glossary term key. term_relationship_key (str) – (required) Unique glossary term relationship key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_term_relationship API.

detach_catalog_private_endpoint(detach_catalog_private_endpoint_details, catalog_id, **kwargs)¶

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:	detach_catalog_private_endpoint_details (oci.data_catalog.models.DetachCatalogPrivateEndpointDetails) – (required) Details for private reverse connection endpoint to be used for attachment catalog_id (str) – (required) Unique catalog identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use detach_catalog_private_endpoint API.

disassociate_custom_property(catalog_id, type_key, disassociate_custom_property_details, **kwargs)¶

Remove the custom property for the given type

Parameters:	catalog_id (str) – (required) Unique catalog identifier. type_key (str) – (required) Unique type key. disassociate_custom_property_details (oci.data_catalog.models.TypeCustomPropertyDetails) – (required) The information used to remove the custom properties. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Type`
Return type:	`Response`
Example:

Click here to see an example of how to use disassociate_custom_property API.

expand_tree_for_glossary(catalog_id, glossary_key, **kwargs)¶

Returns the fully expanded tree hierarchy of parent and child terms in this glossary.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `GlossaryTreeElement`
Return type:	`Response`
Example:

Click here to see an example of how to use expand_tree_for_glossary API.

export_glossary(catalog_id, glossary_key, **kwargs)¶

Export the glossary and the terms and return the exported glossary as csv or json.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. is_relationship_exported (bool) – (optional) Specify if the relationship metadata is exported for the glossary. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type str
Return type:	`Response`
Example:

Click here to see an example of how to use export_glossary API.

fetch_entity_lineage(catalog_id, data_asset_key, entity_key, fetch_entity_lineage_details, **kwargs)¶

Returns lineage for a given entity object.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. fetch_entity_lineage_details (oci.data_catalog.models.FetchEntityLineageDetails) – (required) The information needed to obtain desired lineage. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EntityLineage`
Return type:	`Response`
Example:

Click here to see an example of how to use fetch_entity_lineage API.

get_attribute(catalog_id, data_asset_key, entity_key, attribute_key, **kwargs)¶

Gets a specific entity attribute by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. attribute_key (str) – (required) Unique attribute key. is_include_object_relationships (bool) – (optional) Indicates whether the list of objects and their relationships to this object will be provided in the response. fields (list[str]) – (optional) Specifies the fields to return in an entity attribute response. Allowed values are: “key”, “displayName”, “description”, “entityKey”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “externalDataType”, “externalKey”, “isIncrementalData”, “isNullable”, “length”, “position”, “precision”, “scale”, “timeExternal”, “uri”, “properties”, “path”, “minCollectionCount”, “maxCollectionCount”, “datatypeEntityKey”, “externalDatatypeEntityKey”, “parentAttributeKey”, “externalParentAttributeKey”, “typeKey” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Attribute`
Return type:	`Response`
Example:

Click here to see an example of how to use get_attribute API.

get_attribute_tag(catalog_id, data_asset_key, entity_key, attribute_key, tag_key, **kwargs)¶

Gets a specific entity attribute tag by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. attribute_key (str) – (required) Unique attribute key. tag_key (str) – (required) Unique tag key. fields (list[str]) – (optional) Specifies the fields to return in an entity attribute tag response. Allowed values are: “key”, “name”, “termKey”, “termPath”, “termDescription”, “lifecycleState”, “timeCreated”, “createdById”, “uri”, “attributeKey” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AttributeTag`
Return type:	`Response`
Example:

Click here to see an example of how to use get_attribute_tag API.

get_catalog(catalog_id, **kwargs)¶

Gets a data catalog by identifier.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Catalog`
Return type:	`Response`
Example:

Click here to see an example of how to use get_catalog API.

get_catalog_private_endpoint(catalog_private_endpoint_id, **kwargs)¶

Gets a specific private reverse connection by identifier.

Parameters:	catalog_private_endpoint_id (str) – (required) Unique private reverse connection identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CatalogPrivateEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use get_catalog_private_endpoint API.

get_connection(catalog_id, data_asset_key, connection_key, **kwargs)¶

Gets a specific data asset connection by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. connection_key (str) – (required) Unique connection key. fields (list[str]) – (optional) Specifies the fields to return in a connection response. Allowed values are: “key”, “displayName”, “description”, “dataAssetKey”, “typeKey”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “properties”, “externalKey”, “timeStatusUpdated”, “lifecycleState”, “isDefault”, “uri” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use get_connection API.

get_custom_property(catalog_id, namespace_id, custom_property_key, **kwargs)¶

Gets a specific custom property for the given key within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. namespace_id (str) – (required) Unique namespace identifier. custom_property_key (str) – (required) Unique Custom Property key fields (list[str]) – (optional) Specifies the fields to return in a custom property response. Allowed values are: “key”, “displayName”, “description”, “dataType”, “namespaceName”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “properties” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CustomProperty`
Return type:	`Response`
Example:

Click here to see an example of how to use get_custom_property API.

get_data_asset(catalog_id, data_asset_key, **kwargs)¶

Gets a specific data asset for the given key within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. fields (list[str]) – (optional) Specifies the fields to return in a data asset response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “externalKey”, “typeKey”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “uri”, “properties” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use get_data_asset API.

get_data_asset_tag(catalog_id, data_asset_key, tag_key, **kwargs)¶

Gets a specific data asset tag by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. tag_key (str) – (required) Unique tag key. fields (list[str]) – (optional) Specifies the fields to return in a data asset tag response. Allowed values are: “key”, “name”, “termKey”, “termPath”, “termDescription”, “lifecycleState”, “timeCreated”, “createdById”, “uri”, “dataAssetKey” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAssetTag`
Return type:	`Response`
Example:

Click here to see an example of how to use get_data_asset_tag API.

get_entity(catalog_id, data_asset_key, entity_key, **kwargs)¶

Gets a specific data entity by key for a data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. is_include_object_relationships (bool) – (optional) Indicates whether the list of objects and their relationships to this object will be provided in the response. fields (list[str]) – (optional) Specifies the fields to return in an entity response. Allowed values are: “key”, “displayName”, “description”, “dataAssetKey”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “lifecycleState”, “externalKey”, “timeExternal”, “timeStatusUpdated”, “isLogical”, “isPartition”, “folderKey”, “folderName”, “typeKey”, “path”, “harvestStatus”, “lastJobKey”, “uri”, “properties” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Entity`
Return type:	`Response`
Example:

Click here to see an example of how to use get_entity API.

get_entity_tag(catalog_id, data_asset_key, entity_key, tag_key, **kwargs)¶

Gets a specific entity tag by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. tag_key (str) – (required) Unique tag key. fields (list[str]) – (optional) Specifies the fields to return in an entity tag response. Allowed values are: “key”, “name”, “termKey”, “termPath”, “termDescription”, “lifecycleState”, “timeCreated”, “createdById”, “uri”, “entityKey” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EntityTag`
Return type:	`Response`
Example:

Click here to see an example of how to use get_entity_tag API.

get_folder(catalog_id, data_asset_key, folder_key, **kwargs)¶

Gets a specific data asset folder by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. folder_key (str) – (required) Unique folder key. is_include_object_relationships (bool) – (optional) Indicates whether the list of objects and their relationships to this object will be provided in the response. fields (list[str]) – (optional) Specifies the fields to return in a folder response. Allowed values are: “key”, “displayName”, “description”, “parentFolderKey”, “path”, “dataAssetKey”, “properties”, “externalKey”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “timeExternal”, “lifecycleState”, “harvestStatus”, “lastJobKey”, “uri” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Folder`
Return type:	`Response`
Example:

Click here to see an example of how to use get_folder API.

get_folder_tag(catalog_id, data_asset_key, folder_key, tag_key, **kwargs)¶

Gets a specific folder tag by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. folder_key (str) – (required) Unique folder key. tag_key (str) – (required) Unique tag key. fields (list[str]) – (optional) Specifies the fields to return in a folder tag response. Allowed values are: “key”, “name”, “termKey”, “termPath”, “termDescription”, “lifecycleState”, “timeCreated”, “createdById”, “uri”, “folderKey” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FolderTag`
Return type:	`Response`
Example:

Click here to see an example of how to use get_folder_tag API.

get_glossary(catalog_id, glossary_key, **kwargs)¶

Gets a specific glossary by key within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. fields (list[str]) – (optional) Specifies the fields to return in a glossary response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “owner”, “workflowStatus”, “uri” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Glossary`
Return type:	`Response`
Example:

Click here to see an example of how to use get_glossary API.

get_job(catalog_id, job_key, **kwargs)¶

Gets a specific job by key within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. fields (list[str]) – (optional) Specifies the fields to return in a job response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “lifecycleState”, “timeCreated”, “timeUpdated”, “jobType”, “scheduleCronExpression”, “timeScheduleBegin”, “timeScheduleEnd”, “scheduleType”, “connectionKey”, “jobDefinitionKey”, “internalVersion”, “executionCount”, “timeOfLatestExecution”, “executions”, “createdById”, “updatedById”, “uri”, “jobDefinitionName”, “errorCode”, “errorMessage” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Job`
Return type:	`Response`
Example:

Click here to see an example of how to use get_job API.

get_job_definition(catalog_id, job_definition_key, **kwargs)¶

Gets a specific job definition by key within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_definition_key (str) – (required) Unique job definition key. fields (list[str]) – (optional) Specifies the fields to return in a job definition response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “jobType”, “isIncremental”, “dataAssetKey”, “connectionKey”, “internalVersion”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “uri”, “isSampleDataExtracted”, “sampleDataSizeInMBs”, “timeLatestExecutionStarted”, “timeLatestExecutionEnded”, “jobExecutionState”, “scheduleType”, “properties” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobDefinition`
Return type:	`Response`
Example:

Click here to see an example of how to use get_job_definition API.

get_job_execution(catalog_id, job_key, job_execution_key, **kwargs)¶

Gets a specific job execution by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. job_execution_key (str) – (required) The key of the job execution. fields (list[str]) – (optional) Specifies the fields to return in a job execution response. Allowed values are: “key”, “jobKey”, “jobType”, “subType”, “parentKey”, “scheduleInstanceKey”, “lifecycleState”, “timeCreated”, “timeStarted”, “timeEnded”, “errorCode”, “errorMessage”, “processKey”, “externalUrl”, “eventKey”, “dataEntityKey”, “createdById”, “updatedById”, “properties”, “uri” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobExecution`
Return type:	`Response`
Example:

Click here to see an example of how to use get_job_execution API.

get_job_log(catalog_id, job_key, job_execution_key, job_log_key, **kwargs)¶

Gets a specific job log by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. job_execution_key (str) – (required) The key of the job execution. job_log_key (str) – (required) Unique job log key. fields (list[str]) – (optional) Specifies the fields to return in a job log response. Allowed values are: “key”, “jobExecutionKey”, “createdById”, “updatedById”, “timeUpdated”, “timeCreated”, “severity”, “logMessage”, “uri” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobLog`
Return type:	`Response`
Example:

Click here to see an example of how to use get_job_log API.

get_job_metrics(catalog_id, job_key, job_execution_key, job_metrics_key, **kwargs)¶

Gets a specific job metric by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. job_execution_key (str) – (required) The key of the job execution. job_metrics_key (str) – (required) Unique job metrics key. fields (list[str]) – (optional) Specifies the fields to return in a job metric response. Allowed values are: “key”, “description”, “displayName”, “timeInserted”, “category”, “subCategory”, “unit”, “value”, “batchKey”, “jobExecutionKey”, “createdById”, “updatedById”, “timeUpdated”, “timeCreated”, “uri” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobMetric`
Return type:	`Response`
Example:

Click here to see an example of how to use get_job_metrics API.

get_metastore(metastore_id, **kwargs)¶

Gets a metastore by identifier.

Parameters:	metastore_id (str) – (required) The metastore’s OCID. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Metastore`
Return type:	`Response`
Example:

Click here to see an example of how to use get_metastore API.

get_namespace(catalog_id, namespace_id, **kwargs)¶

Gets a specific namespace for the given key within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. namespace_id (str) – (required) Unique namespace identifier. fields (list[str]) – (optional) Specifies the fields to return in a namespace response. Allowed values are: “key”, “displayName”, “description”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “properties” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Namespace`
Return type:	`Response`
Example:

Click here to see an example of how to use get_namespace API.

get_pattern(catalog_id, pattern_key, **kwargs)¶

Gets a specific pattern for the given key within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. pattern_key (str) – (required) Unique pattern key. fields (list[str]) – (optional) Specifies the fields to return in a pattern response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “expression”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “properties” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Pattern`
Return type:	`Response`
Example:

Click here to see an example of how to use get_pattern API.

get_term(catalog_id, glossary_key, term_key, **kwargs)¶

Gets a specific glossary term by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. term_key (str) – (required) Unique glossary term key. fields (list[str]) – (optional) Specifies the fields to return in a term response. Allowed values are: “key”, “displayName”, “description”, “glossaryKey”, “parentTermKey”, “isAllowedToHaveChildTerms”, “path”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “owner”, “workflowStatus”, “uri”, “relatedTerms”, “associatedObjectCount”, “associatedObjects” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Term`
Return type:	`Response`
Example:

Click here to see an example of how to use get_term API.

get_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, **kwargs)¶

Gets a specific glossary term relationship by key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. term_key (str) – (required) Unique glossary term key. term_relationship_key (str) – (required) Unique glossary term relationship key. fields (list[str]) – (optional) Specifies the fields to return in a term relationship response. Allowed values are: “key”, “displayName”, “description”, “relatedTermKey”, “relatedTermDisplayName”, “parentTermKey”, “parentTermDisplayName”, “lifecycleState”, “timeCreated”, “uri” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TermRelationship`
Return type:	`Response`
Example:

Click here to see an example of how to use get_term_relationship API.

get_type(catalog_id, type_key, **kwargs)¶

Gets a specific type by key within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. type_key (str) – (required) Unique type key. fields (list[str]) – (optional) Specifies the fields to return in a type response. Allowed values are: “key”, “description”, “name”, “catalogId”, “properties”, “isInternal”, “isTag”, “isApproved”, “typeCategory”, “externalTypeName”, “lifecycleState”, “uri” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Type`
Return type:	`Response`
Example:

Click here to see an example of how to use get_type API.

get_work_request(work_request_id, **kwargs)¶

Gets the status of the work request with the given OCID.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

import_connection(catalog_id, data_asset_key, import_connection_details, **kwargs)¶

Import new connection for this data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. import_connection_details (oci.data_catalog.models.ImportConnectionDetails) – (required) The information used to create the connections through import. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use import_connection API.

import_data_asset(catalog_id, data_asset_key, import_data_asset_details, import_type, **kwargs)¶

Import technical objects to a Data Asset

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. import_data_asset_details (oci.data_catalog.models.ImportDataAssetDetails) – (required) The file contents to be imported. import_type (oci.data_catalog.models.list[str]) – (required) Type of import. Allowed values are: “CUSTOM_PROPERTY_VALUES”, “ALL” is_missing_value_ignored (bool) – (optional) Specify whether to ignore the missing values in the import file. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportDataAssetJobResult`
Return type:	`Response`
Example:

Click here to see an example of how to use import_data_asset API.

import_glossary(catalog_id, glossary_key, import_glossary_details, **kwargs)¶

Import the glossary and the terms from csv or json files and return the imported glossary resource.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. import_glossary_details (oci.data_catalog.models.ImportGlossaryDetails) – (required) The file contents to import the glossary. is_relationship_imported (bool) – (optional) Specify if the relationship metadata is imported for the glossary. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use import_glossary API.

import_lineage(catalog_id, data_asset_key, import_lineage_details, **kwargs)¶

Imports lineage metadata. Returns details about the job that performs the import.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. import_lineage_details (oci.data_catalog.models.ImportLineageDetails) – (required) Details needed by the lineage import request. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportLineageJobResult`
Return type:	`Response`
Example:

Click here to see an example of how to use import_lineage API.

list_aggregated_physical_entities(catalog_id, data_asset_key, entity_key, **kwargs)¶

List the physical entities aggregated by this logical entity.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. fields (list[str]) – (optional) Specifies the fields to return in an entity response. Allowed values are: “key”, “displayName”, “description”, “dataAssetKey”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “lifecycleState”, “externalKey”, “timeExternal”, “timeStatusUpdated”, “isLogical”, “isPartition”, “folderKey”, “folderName”, “typeKey”, “path”, “harvestStatus”, “lastJobKey”, “uri”, “properties” display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. is_include_properties (bool) – (optional) Indicates whether the properties map will be provided in the response. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EntityCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_aggregated_physical_entities API.

list_attribute_tags(catalog_id, data_asset_key, entity_key, attribute_key, **kwargs)¶

Returns a list of all tags for an entity attribute.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. attribute_key (str) – (required) Unique attribute key. name (str) – (optional) Immutable resource name. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” term_key (str) – (optional) Unique key of the related term. term_path (str) – (optional) Path of the related term. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. fields (list[str]) – (optional) Specifies the fields to return in an entity attribute tag summary response. Allowed values are: “key”, “name”, “termKey”, “termPath”, “termDescription”, “lifecycleState”, “timeCreated”, “uri”, “glossaryKey”, “attributeKey” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AttributeTagCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_attribute_tags API.

list_attributes(catalog_id, data_asset_key, entity_key, **kwargs)¶

Returns a list of all attributes of an data entity.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. business_name (str) – (optional) A filter to return only resources that match the entire business name given. The match is not case sensitive. display_or_business_name_contains (str) – (optional) A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with “Cu” or has the pattern “Cu” anywhere in between. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. external_key (str) – (optional) Unique external identifier of this resource in the external source system. time_external (datetime) – (optional) Last modified timestamp of this object in the external system. external_type_name (str) – (optional) Data type as defined in an external system. is_incremental_data (bool) – (optional) Identifies whether this attribute can be used as a watermark to extract incremental data. is_nullable (bool) – (optional) Identifies whether this attribute can be assigned null value. length (int) – (optional) Max allowed length of the attribute value. position (int) – (optional) Position of the attribute in the record definition. precision (int) – (optional) Precision of the attribute value usually applies to float data type. scale (int) – (optional) Scale of the attribute value usually applies to float data type. fields (list[str]) – (optional) Specifies the fields to return in an entity attribute summary response. Allowed values are: “key”, “displayName”, “description”, “entityKey”, “lifecycleState”, “timeCreated”, “externalDataType”, “externalKey”, “length”, “precision”, “scale”, “isNullable”, “uri”, “path”, “minCollectionCount”, “maxCollectionCount”, “datatypeEntityKey”, “externalDatatypeEntityKey”, “parentAttributeKey”, “externalParentAttributeKey”, “position”, “typeKey” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default. Allowed values are: “TIMECREATED”, “DISPLAYNAME”, “POSITION”, “DISPLAYORBUSINESSNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AttributeCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_attributes API.

list_catalog_private_endpoints(compartment_id, **kwargs)¶

Returns a list of all the catalog private endpoints in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment where you want to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `CatalogPrivateEndpointSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_catalog_private_endpoints API.

list_catalogs(compartment_id, **kwargs)¶

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

Parameters:	compartment_id (str) – (required) The OCID of the compartment where you want to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `CatalogSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_catalogs API.

list_connections(catalog_id, data_asset_key, **kwargs)¶

Returns a list of all Connections for a data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. external_key (str) – (optional) Unique external identifier of this resource in the external source system. time_status_updated (datetime) – (optional) Time that the resource’s status was last updated. An RFC3339 formatted datetime string. is_default (bool) – (optional) Indicates whether this connection is the default connection. fields (list[str]) – (optional) Specifies the fields to return in a connection summary response. Allowed values are: “key”, “displayName”, “description”, “dataAssetKey”, “typeKey”, “timeCreated”, “externalKey”, “lifecycleState”, “isDefault”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_connections API.

list_custom_properties(catalog_id, namespace_id, **kwargs)¶

Returns a list of custom properties within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. namespace_id (str) – (required) Unique namespace identifier. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. data_types (list[str]) – (optional) Return the custom properties which has specified data types Allowed values are: “TEXT”, “RICH_TEXT”, “BOOLEAN”, “NUMBER”, “DATE” type_name (list[str]) – (optional) A filter to return only resources that match the entire type name given. The match is not case sensitive Allowed values are: “DATA_ASSET”, “AUTONOMOUS_DATA_WAREHOUSE”, “HIVE”, “KAFKA”, “MYSQL”, “ORACLE_OBJECT_STORAGE”, “AUTONOMOUS_TRANSACTION_PROCESSING”, “ORACLE”, “POSTGRESQL”, “MICROSOFT_AZURE_SQL_DATABASE”, “MICROSOFT_SQL_SERVER”, “IBM_DB2”, “DATA_ENTITY”, “LOGICAL_ENTITY”, “TABLE”, “VIEW”, “ATTRIBUTE”, “FOLDER”, “ORACLE_ANALYTICS_SUBJECT_AREA_COLUMN”, “ORACLE_ANALYTICS_LOGICAL_COLUMN”, “ORACLE_ANALYTICS_PHYSICAL_COLUMN”, “ORACLE_ANALYTICS_ANALYSIS_COLUMN”, “ORACLE_ANALYTICS_SERVER”, “ORACLE_ANALYTICS_CLOUD”, “ORACLE_ANALYTICS_SUBJECT_AREA”, “ORACLE_ANALYTICS_DASHBOARD”, “ORACLE_ANALYTICS_BUSINESS_MODEL”, “ORACLE_ANALYTICS_PHYSICAL_DATABASE”, “ORACLE_ANALYTICS_PHYSICAL_SCHEMA”, “ORACLE_ANALYTICS_PRESENTATION_TABLE”, “ORACLE_ANALYTICS_LOGICAL_TABLE”, “ORACLE_ANALYTICS_PHYSICAL_TABLE”, “ORACLE_ANALYTICS_ANALYSIS”, “DATABASE_SCHEMA”, “TOPIC”, “CONNECTION”, “GLOSSARY”, “TERM”, “CATEGORY”, “FILE”, “BUCKET”, “MESSAGE”, “UNRECOGNIZED_FILE” lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. fields (list[str]) – (optional) Specifies the fields to return in a custom property summary response. Allowed values are: “key”, “displayName”, “description”, “dataType”, “namespaceName”, “lifecycleState”, “timeCreated” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending Allowed values are: “DISPLAYNAME”, “USAGECOUNT” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CustomPropertyCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_custom_properties API.

list_data_asset_tags(catalog_id, data_asset_key, **kwargs)¶

Returns a list of all tags for a data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. name (str) – (optional) Immutable resource name. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” term_key (str) – (optional) Unique key of the related term. term_path (str) – (optional) Path of the related term. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. fields (list[str]) – (optional) Specifies the fields to return in a data asset tag summary response. Allowed values are: “key”, “name”, “termKey”, “termPath”, “termDescription”, “lifecycleState”, “timeCreated”, “uri”, “glossaryKey”, “dataAssetKey” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAssetTagCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_data_asset_tags API.

list_data_assets(catalog_id, **kwargs)¶

Returns a list of data assets within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. external_key (str) – (optional) Unique external identifier of this resource in the external source system. type_key (str) – (optional) The key of the object type. fields (list[str]) – (optional) Specifies the fields to return in a data asset summary response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “externalKey”, “typeKey”, “lifecycleState”, “timeCreated”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAssetCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_data_assets API.

list_derived_logical_entities(catalog_id, pattern_key, **kwargs)¶

List logical entities derived from this pattern.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. pattern_key (str) – (required) Unique pattern key. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EntityCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_derived_logical_entities API.

list_entities(catalog_id, data_asset_key, **kwargs)¶

Returns a list of all entities of a data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. business_name (str) – (optional) A filter to return only resources that match the entire business name given. The match is not case sensitive. display_or_business_name_contains (str) – (optional) A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with “Cu” or has the pattern “Cu” anywhere in between. type_key (str) – (optional) The key of the object type. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. external_key (str) – (optional) Unique external identifier of this resource in the external source system. pattern_key (str) – (optional) Unique pattern key. time_external (datetime) – (optional) Last modified timestamp of this object in the external system. time_status_updated (datetime) – (optional) Time that the resource’s status was last updated. An RFC3339 formatted datetime string. is_logical (bool) – (optional) Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects. is_partition (bool) – (optional) Identifies if an object is a sub object (partition) of a physical or materialized parent object. folder_key (str) – (optional) Key of the associated folder. path (str) – (optional) Full path of the resource for resources that support paths. harvest_status (str) – (optional) Harvest status of the harvestable resource as updated by the harvest process. Allowed values are: “COMPLETE”, “ERROR”, “IN_PROGRESS”, “DEFERRED” last_job_key (str) – (optional) Key of the last harvest process to update this resource. fields (list[str]) – (optional) Specifies the fields to return in an entity summary response. Allowed values are: “key”, “displayName”, “description”, “dataAssetKey”, “timeCreated”, “timeUpdated”, “updatedById”, “lifecycleState”, “folderKey”, “folderName”, “externalKey”, “path”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default. Allowed values are: “TIMECREATED”, “DISPLAYNAME”, “DISPLAYORBUSINESSNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. is_process (bool) – (optional) A filter to return only process entities. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EntityCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_entities API.

list_entity_tags(catalog_id, data_asset_key, entity_key, **kwargs)¶

Returns a list of all tags for a data entity.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. name (str) – (optional) Immutable resource name. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” term_key (str) – (optional) Unique key of the related term. term_path (str) – (optional) Path of the related term. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. fields (list[str]) – (optional) Specifies the fields to return in an entity tag summary response. Allowed values are: “key”, “name”, “termKey”, “termPath”, “termDescription”, “lifecycleState”, “timeCreated”, “uri”, “glossaryKey”, “entityKey” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EntityTagCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_entity_tags API.

list_folder_tags(catalog_id, data_asset_key, folder_key, **kwargs)¶

Returns a list of all tags for a folder.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. folder_key (str) – (required) Unique folder key. name (str) – (optional) Immutable resource name. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” term_key (str) – (optional) Unique key of the related term. term_path (str) – (optional) Path of the related term. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. fields (list[str]) – (optional) Specifies the fields to return in a folder tag summary response. Allowed values are: “key”, “name”, “termKey”, “termPath”, “termDescription”, “lifecycleState”, “timeCreated”, “uri”, “glossaryKey”, “folderKey” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FolderTagCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_folder_tags API.

list_folders(catalog_id, data_asset_key, **kwargs)¶

Returns a list of all folders.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. business_name (str) – (optional) A filter to return only resources that match the entire business name given. The match is not case sensitive. display_or_business_name_contains (str) – (optional) A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with “Cu” or has the pattern “Cu” anywhere in between. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” parent_folder_key (str) – (optional) Unique folder key. path (str) – (optional) Full path of the resource for resources that support paths. external_key (str) – (optional) Unique external identifier of this resource in the external source system. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. harvest_status (str) – (optional) Harvest status of the harvestable resource as updated by the harvest process. Allowed values are: “COMPLETE”, “ERROR”, “IN_PROGRESS”, “DEFERRED” last_job_key (str) – (optional) Key of the last harvest process to update this resource. fields (list[str]) – (optional) Specifies the fields to return in a folder summary response. Allowed values are: “key”, “displayName”, “description”, “parentFolderKey”, “path”, “dataAssetKey”, “externalKey”, “timeExternal”, “timeCreated”, “lifecycleState”, “uri” type_key (str) – (optional) The key of the object type. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default. Allowed values are: “TIMECREATED”, “DISPLAYNAME”, “DISPLAYORBUSINESSNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FolderCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_folders API.

list_glossaries(catalog_id, **kwargs)¶

Returns a list of all glossaries within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. fields (list[str]) – (optional) Specifies the fields to return in a glossary summary response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “lifecycleState”, “timeCreated”, “uri”, “workflowStatus” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `GlossaryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_glossaries API.

list_job_definitions(catalog_id, **kwargs)¶

Returns a list of job definitions within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. job_execution_state (str) – (optional) Job execution state. Allowed values are: “CREATED”, “IN_PROGRESS”, “INACTIVE”, “FAILED”, “SUCCEEDED”, “CANCELED”, “SUCCEEDED_WITH_WARNINGS” lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” job_type (str) – (optional) Job type. Allowed values are: “HARVEST”, “PROFILING”, “SAMPLING”, “PREVIEW”, “IMPORT”, “EXPORT”, “IMPORT_GLOSSARY”, “EXPORT_GLOSSARY”, “INTERNAL”, “PURGE”, “IMMEDIATE”, “SCHEDULED”, “IMMEDIATE_EXECUTION”, “SCHEDULED_EXECUTION”, “SCHEDULED_EXECUTION_INSTANCE”, “ASYNC_DELETE”, “IMPORT_DATA_ASSET”, “CREATE_SCAN_PROXY”, “ASYNC_EXPORT_GLOSSARY”, “ASYNC_EXPORT_DATA_ASSET” is_incremental (bool) – (optional) Whether job definition is an incremental harvest (true) or a full harvest (false). data_asset_key (str) – (optional) Unique data asset key. glossary_key (str) – (optional) Unique glossary key. connection_key (str) – (optional) Unique connection key. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. sample_data_size_in_mbs (str) – (optional) The sample data size in MB, specified as number of rows, for a metadata harvest. fields (list[str]) – (optional) Specifies the fields to return in a job definition summary response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “jobType”, “connectionKey”, “lifecycleState”, “timeCreated”, “isSampleDataExtracted”, “uri”, “timeLatestExecutionStarted”, “timeLatestExecutionEnded”, “jobExecutionState”, “scheduleType” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. Default order for TIMELATESTEXECUTIONSTARTED is descending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME”, “TIMELATESTEXECUTIONSTARTED” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobDefinitionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_job_definitions API.

list_job_executions(catalog_id, job_key, **kwargs)¶

Returns a list of job executions for a job.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. lifecycle_state (str) – (optional) Job execution lifecycle state. Allowed values are: “CREATED”, “IN_PROGRESS”, “INACTIVE”, “FAILED”, “SUCCEEDED”, “CANCELED”, “SUCCEEDED_WITH_WARNINGS” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. job_type (str) – (optional) Job type. Allowed values are: “HARVEST”, “PROFILING”, “SAMPLING”, “PREVIEW”, “IMPORT”, “EXPORT”, “IMPORT_GLOSSARY”, “EXPORT_GLOSSARY”, “INTERNAL”, “PURGE”, “IMMEDIATE”, “SCHEDULED”, “IMMEDIATE_EXECUTION”, “SCHEDULED_EXECUTION”, “SCHEDULED_EXECUTION_INSTANCE”, “ASYNC_DELETE”, “IMPORT_DATA_ASSET”, “CREATE_SCAN_PROXY”, “ASYNC_EXPORT_GLOSSARY”, “ASYNC_EXPORT_DATA_ASSET” sub_type (str) – (optional) Sub-type of this job execution. parent_key (str) – (optional) The unique key of the parent execution or null if this job execution has no parent. time_start (datetime) – (optional) Time that the job execution was started or in the case of a future time, the time when the job will start. An RFC3339 formatted datetime string. time_end (datetime) – (optional) Time that the job execution ended or null if the job is still running or hasn’t run yet. An RFC3339 formatted datetime string. error_code (str) – (optional) Error code returned from the job execution or null if job is still running or didn’t return an error. error_message (str) – (optional) Error message returned from the job execution or null if job is still running or didn’t return an error. process_key (str) – (optional) Process identifier related to the job execution. external_url (str) – (optional) The a URL of the job for accessing this resource and its status. event_key (str) – (optional) Event that triggered the execution of this job or null. data_entity_key (str) – (optional) Unique entity key. fields (list[str]) – (optional) Specifies the fields to return in a job execution summary response. Allowed values are: “key”, “jobKey”, “jobType”, “parentKey”, “scheduleInstanceKey”, “lifecycleState”, “timeCreated”, “timeStarted”, “timeEnded”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order. Allowed values are: “TIMECREATED” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobExecutionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_job_executions API.

list_job_logs(catalog_id, job_key, job_execution_key, **kwargs)¶

Returns a list of job logs.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. job_execution_key (str) – (required) The key of the job execution. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” severity (str) – (optional) Severity level for this Log. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. fields (list[str]) – (optional) Specifies the fields to return in a job log summary response. Allowed values are: “key”, “jobExecutionKey”, “severity”, “timeCreated”, “logMessage”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobLogCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_job_logs API.

list_job_metrics(catalog_id, job_key, job_execution_key, **kwargs)¶

Returns a list of job metrics.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. job_execution_key (str) – (required) The key of the job execution. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. category (str) – (optional) Category of this metric. sub_category (str) – (optional) Sub category of this metric under the category. Used for aggregating values. May be null. unit (str) – (optional) Unit of this metric. value (str) – (optional) Value of this metric. batch_key (str) – (optional) Batch key for grouping, may be null. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. time_inserted (datetime) – (optional) The time the metric was logged or captured in the system where the job executed. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. fields (list[str]) – (optional) Specifies the fields to return in a job metric summary response. Allowed values are: “key”, “description”, “displayName”, “timeInserted”, “category”, “subCategory”, “unit”, “value”, “batchKey”, “jobExecutionKey”, “timeCreated”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobMetricCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_job_metrics API.

list_jobs(catalog_id, **kwargs)¶

Returns a list of jobs within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) Job lifecycle state. Allowed values are: “ACTIVE”, “INACTIVE”, “EXPIRED” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. job_type (str) – (optional) Job type. Allowed values are: “HARVEST”, “PROFILING”, “SAMPLING”, “PREVIEW”, “IMPORT”, “EXPORT”, “IMPORT_GLOSSARY”, “EXPORT_GLOSSARY”, “INTERNAL”, “PURGE”, “IMMEDIATE”, “SCHEDULED”, “IMMEDIATE_EXECUTION”, “SCHEDULED_EXECUTION”, “SCHEDULED_EXECUTION_INSTANCE”, “ASYNC_DELETE”, “IMPORT_DATA_ASSET”, “CREATE_SCAN_PROXY”, “ASYNC_EXPORT_GLOSSARY”, “ASYNC_EXPORT_DATA_ASSET” job_definition_key (str) – (optional) Unique job definition key. data_asset_key (str) – (optional) Unique data asset key. glossary_key (str) – (optional) Unique glossary key. schedule_cron_expression (str) – (optional) Interval on which the job will be run. Value is specified as a cron-supported time specification “nickname”. The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency. time_schedule_begin (datetime) – (optional) Date that the schedule should be operational. An RFC3339 formatted datetime string. time_schedule_end (datetime) – (optional) Date that the schedule should end from being operational. An RFC3339 formatted datetime string. schedule_type (str) – (optional) Type of the job schedule. Allowed values are: “SCHEDULED”, “IMMEDIATE” connection_key (str) – (optional) Unique connection key. fields (list[str]) – (optional) Specifies the fields to return in a job summary response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “jobDefinitionKey”, “lifecycleState”, “timeCreated”, “timeUpdated”, “createdById”, “updatedById”, “jobType”, “scheduleCronExpression”, “timeScheduleBegin”, “scheduleType”, “executionCount”, “timeOfLatestExecution”, “executions”, “uri”, “jobDefinitionName”, “errorCode”, “errorMessage” execution_count (int) – (optional) The total number of executions for this job schedule. time_of_latest_execution (datetime) – (optional) The date and time the most recent execution for this job ,in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_jobs API.

list_metastores(compartment_id, **kwargs)¶

Returns a list of all metastores in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment where you want to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `MetastoreSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_metastores API.

list_namespaces(catalog_id, **kwargs)¶

Returns a list of namespaces within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” fields (list[str]) – (optional) Specifies the fields to return in a namespace summary response. Allowed values are: “key”, “displayName”, “description”, “lifecycleState”, “timeCreated” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NamespaceCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_namespaces API.

list_patterns(catalog_id, **kwargs)¶

Returns a list of patterns within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. fields (list[str]) – (optional) Specifies the fields to return in a pattern summary response. Allowed values are: “key”, “displayName”, “description”, “catalogId”, “expression”, “lifecycleState”, “timeCreated” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PatternCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_patterns API.

list_rules(catalog_id, data_asset_key, entity_key, **kwargs)¶

Returns a list of all rules of a data entity.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. rule_type (str) – (optional) Rule type used to filter the response to a list rules call. Allowed values are: “PRIMARYKEY”, “FOREIGNKEY”, “UNIQUEKEY” lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” origin_type (str) – (optional) Rule origin type used to filter the response to a list rules call. Allowed values are: “SOURCE”, “USER”, “PROFILING” external_key (str) – (optional) Unique external identifier of this resource in the external source system. time_created (datetime) – (optional) Time that the resource was created. An RFC3339 formatted datetime string. time_updated (datetime) – (optional) Time that the resource was updated. An RFC3339 formatted datetime string. created_by_id (str) – (optional) OCID of the user who created the resource. updated_by_id (str) – (optional) OCID of the user who updated the resource. fields (list[str]) – (optional) Specifies the fields to return in a rule summary response. Allowed values are: “key”, “displayName”, “ruleType”, “externalKey”, “referencedFolderKey”, “referencedFolderName”, “referencedEntityKey”, “referencedEntityName”, “referencedRuleKey”, “referencedRuleName”, “originType”, “lifecycleState”, “timeCreated”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RuleCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_rules API.

list_tags(catalog_id, **kwargs)¶

Returns a list of all user created tags in the system.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” fields (list[str]) – (optional) Specifies the fields to return in a term summary response. Allowed values are: “key”, “displayName”, “description”, “glossaryKey”, “parentTermKey”, “isAllowedToHaveChildTerms”, “path”, “lifecycleState”, “timeCreated”, “workflowStatus”, “associatedObjectCount”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TermCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_tags API.

list_term_relationships(catalog_id, glossary_key, term_key, **kwargs)¶

Returns a list of all term relationships within a glossary.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. term_key (str) – (required) Unique glossary term key. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” fields (list[str]) – (optional) Specifies the fields to return in a term relationship summary response. Allowed values are: “key”, “displayName”, “description”, “relatedTermKey”, “relatedTermDisplayName”, “parentTermKey”, “parentTermDisplayName”, “lifecycleState”, “timeCreated”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TermRelationshipCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_term_relationships API.

list_terms(catalog_id, glossary_key, **kwargs)¶

Returns a list of all terms within a glossary.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. display_name_contains (str) – (optional) A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” parent_term_key (str) – (optional) Unique key of the parent term. is_allowed_to_have_child_terms (bool) – (optional) Indicates whether a term may contain child terms. workflow_status (str) – (optional) Status of the approval workflow for this business term in the glossary. Allowed values are: “NEW”, “APPROVED”, “UNDER_REVIEW”, “ESCALATED” path (str) – (optional) Full path of the resource for resources that support paths. fields (list[str]) – (optional) Specifies the fields to return in a term summary response. Allowed values are: “key”, “displayName”, “description”, “glossaryKey”, “parentTermKey”, “isAllowedToHaveChildTerms”, “path”, “lifecycleState”, “timeCreated”, “workflowStatus”, “associatedObjectCount”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TermCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_terms API.

list_types(catalog_id, **kwargs)¶

Returns a list of all types within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. name (str) – (optional) Immutable resource name. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” is_internal (str) – (optional) Indicates whether the type is internal, making it unavailable for use by metadata elements. is_tag (str) – (optional) Indicates whether the type can be used for tagging metadata elements. is_approved (str) – (optional) Indicates whether the type is approved for use as a classifying object. external_type_name (str) – (optional) Data type as defined in an external system. type_category (str) – (optional) Indicates the category of this type . For example, data assets or connections. fields (list[str]) – (optional) Specifies the fields to return in a type summary response. Allowed values are: “key”, “description”, “name”, “catalogId”, “lifecycleState”, “typeCategory”, “uri” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TypeCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_types API.

list_work_request_errors(work_request_id, **kwargs)¶

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

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for CODE and MESSAGE is ascending. If no value is specified TIMESTAMP is default. Allowed values are: “CODE”, “TIMESTAMP” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestError`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)¶

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

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for MESSAGE is ascending. If no value is specified TIMESTAMP is default. Allowed values are: “MESSAGE”, “TIMESTAMP” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestLog`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment where you want to list resources. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.

object_stats(catalog_id, **kwargs)¶

Returns stats on objects by type in the repository.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type str
Return type:	`Response`
Example:

Click here to see an example of how to use object_stats API.

parse_connection(catalog_id, data_asset_key, parse_connection_details, **kwargs)¶

Parse data asset references through connections from this data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. parse_connection_details (oci.data_catalog.models.ParseConnectionDetails) – (required) The information used to parse the connections from payload or connection detail. connection_key (str) – (optional) Unique connection key. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ConnectionAliasSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use parse_connection API.

process_recommendation(catalog_id, process_recommendation_details, **kwargs)¶

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:	catalog_id (str) – (required) Unique catalog identifier. process_recommendation_details (oci.data_catalog.models.ProcessRecommendationDetails) – (required) Recommendation to be processed. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ProcessRecommendationDetails`
Return type:	`Response`
Example:

Click here to see an example of how to use process_recommendation API.

recommendations(catalog_id, recommendation_type, source_object_key, source_object_type, **kwargs)¶

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:	catalog_id (str) – (required) Unique catalog identifier. recommendation_type (oci.data_catalog.models.list[str]) – (required) A filter used to return only recommendations of the specified type. Allowed values are: “LINK_GLOSSARY_TERM” source_object_key (str) – (required) A filter used to provide the unique identifier of the source object, for which a list of recommendations will be returned for review. source_object_type (str) – (required) A filter used to provide the type of the source object, for which a list of recommendations will be returned for review. Allowed values are: “DATA_ENTITY”, “ATTRIBUTE”, “TERM”, “CATEGORY” recommendation_status (str) – (optional) A filter used to return only recommendations having the requested status. Allowed values are: “ACCEPTED”, “REJECTED”, “INFERRED” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecommendationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use recommendations API.

remove_catalog_lock(catalog_id, remove_resource_lock_details, **kwargs)¶

Removes a lock from a Catalog resource.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. remove_resource_lock_details (oci.data_catalog.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Catalog`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_catalog_lock API.

remove_catalog_private_endpoint_lock(catalog_private_endpoint_id, remove_resource_lock_details, **kwargs)¶

Removes a lock from a CatalogPrivateEndpoint resource.

Parameters:	catalog_private_endpoint_id (str) – (required) Unique private reverse connection identifier. remove_resource_lock_details (oci.data_catalog.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CatalogPrivateEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_catalog_private_endpoint_lock API.

remove_data_selector_patterns(catalog_id, data_asset_key, data_selector_pattern_details, **kwargs)¶

Remove data selector pattern from the data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. data_selector_pattern_details (oci.data_catalog.models.DataSelectorPatternDetails) – (required) The information used to remove the data selector patterns. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_data_selector_patterns API.

remove_metastore_lock(metastore_id, remove_resource_lock_details, **kwargs)¶

Removes a lock from a Metastore resource.

Parameters:	metastore_id (str) – (required) The metastore’s OCID. remove_resource_lock_details (oci.data_catalog.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Metastore`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_metastore_lock API.

search_criteria(catalog_id, **kwargs)¶

Returns a list of search results within a data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. search_criteria_details (oci.data_catalog.models.SearchCriteria) – (optional) The information used to create an extended search results. display_name (str) – (optional) A filter to return only resources that match the entire display name given. The match is not case sensitive. name (str) – (optional) Immutable resource name. lifecycle_state (str) – (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING” timeout (str) – (optional) A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SearchResultCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use search_criteria API.

suggest_matches(catalog_id, input_text, **kwargs)¶

Returns a list of potential string matches for a given input string.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. input_text (str) – (required) Text input string used for computing potential matching suggestions. timeout (str) – (optional) A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout. limit (int) – (optional) Limit for the list of potential matches returned from the Suggest API. If not specified, will default to 10. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SuggestResults`
Return type:	`Response`
Example:

Click here to see an example of how to use suggest_matches API.

synchronous_export_data_asset(catalog_id, data_asset_key, synchronous_export_data_asset_details, export_type, **kwargs)¶

Export technical objects from a Data Asset

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. synchronous_export_data_asset_details (oci.data_catalog.models.ExportDataAssetDetails) – (required) The details of what needs to be exported. export_type (oci.data_catalog.models.list[str]) – (required) Type of export. Allowed values are: “CUSTOM_PROPERTY_VALUES”, “ALL” opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

Click here to see an example of how to use synchronous_export_data_asset API.

test_connection(catalog_id, data_asset_key, connection_key, **kwargs)¶

Test the connection by connecting to the data asset using credentials in the metadata.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. connection_key (str) – (required) Unique connection key. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ValidateConnectionResult`
Return type:	`Response`
Example:

Click here to see an example of how to use test_connection API.

update_attribute(catalog_id, data_asset_key, entity_key, attribute_key, update_attribute_details, **kwargs)¶

Updates a specific data asset attribute.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. attribute_key (str) – (required) Unique attribute key. update_attribute_details (oci.data_catalog.models.UpdateAttributeDetails) – (required) The information to be updated in the attribute. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Attribute`
Return type:	`Response`
Example:

Click here to see an example of how to use update_attribute API.

update_catalog(catalog_id, update_catalog_details, **kwargs)¶

Updates the data catalog.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. update_catalog_details (oci.data_catalog.models.UpdateCatalogDetails) – (required) The data catalog information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Catalog`
Return type:	`Response`
Example:

Click here to see an example of how to use update_catalog API.

update_catalog_private_endpoint(catalog_private_endpoint_id, update_catalog_private_endpoint_details, **kwargs)¶

Updates the private reverse connection endpoint.

Parameters:	catalog_private_endpoint_id (str) – (required) Unique private reverse connection identifier. update_catalog_private_endpoint_details (oci.data_catalog.models.UpdateCatalogPrivateEndpointDetails) – (required) The information to be updated in private reverse connection if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_catalog_private_endpoint API.

update_connection(catalog_id, data_asset_key, connection_key, update_connection_details, **kwargs)¶

Updates a specific connection of a data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. connection_key (str) – (required) Unique connection key. update_connection_details (oci.data_catalog.models.UpdateConnectionDetails) – (required) The information to be updated in the connection. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use update_connection API.

update_custom_property(catalog_id, namespace_id, custom_property_key, update_custom_property_details, **kwargs)¶

Updates a specific custom property identified by the given key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. namespace_id (str) – (required) Unique namespace identifier. custom_property_key (str) – (required) Unique Custom Property key update_custom_property_details (oci.data_catalog.models.UpdateCustomPropertyDetails) – (required) The information to be updated in the custom property. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CustomProperty`
Return type:	`Response`
Example:

Click here to see an example of how to use update_custom_property API.

update_data_asset(catalog_id, data_asset_key, update_data_asset_details, **kwargs)¶

Updates a specific data asset identified by the given key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. update_data_asset_details (oci.data_catalog.models.UpdateDataAssetDetails) – (required) The information to be updated in the data asset. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAsset`
Return type:	`Response`
Example:

Click here to see an example of how to use update_data_asset API.

update_entity(catalog_id, data_asset_key, entity_key, update_entity_details, **kwargs)¶

Updates a specific data entity.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. entity_key (str) – (required) Unique entity key. update_entity_details (oci.data_catalog.models.UpdateEntityDetails) – (required) The information to be updated in the data entity. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Entity`
Return type:	`Response`
Example:

Click here to see an example of how to use update_entity API.

update_folder(catalog_id, data_asset_key, folder_key, update_folder_details, **kwargs)¶

Updates a specific folder of a data asset.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. folder_key (str) – (required) Unique folder key. update_folder_details (oci.data_catalog.models.UpdateFolderDetails) – (required) The information to be updated in the folder. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Folder`
Return type:	`Response`
Example:

Click here to see an example of how to use update_folder API.

update_glossary(catalog_id, glossary_key, update_glossary_details, **kwargs)¶

Updates a specific glossary identified by the given key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. update_glossary_details (oci.data_catalog.models.UpdateGlossaryDetails) – (required) The information to be updated in the glossary. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Glossary`
Return type:	`Response`
Example:

Click here to see an example of how to use update_glossary API.

update_job(catalog_id, job_key, update_job_details, **kwargs)¶

Updates a specific job identified by the given key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_key (str) – (required) Unique job key. update_job_details (oci.data_catalog.models.UpdateJobDetails) – (required) The information to be updated in the job. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Job`
Return type:	`Response`
Example:

Click here to see an example of how to use update_job API.

update_job_definition(catalog_id, job_definition_key, update_job_definition_details, **kwargs)¶

Update a specific job definition identified by the given key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. job_definition_key (str) – (required) Unique job definition key. update_job_definition_details (oci.data_catalog.models.UpdateJobDefinitionDetails) – (required) The information to be updated in the job definition. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `JobDefinition`
Return type:	`Response`
Example:

Click here to see an example of how to use update_job_definition API.

update_metastore(metastore_id, update_metastore_details, **kwargs)¶

Updates a metastore resource by identifier.

Parameters:	metastore_id (str) – (required) The metastore’s OCID. update_metastore_details (oci.data_catalog.models.UpdateMetastoreDetails) – (required) The metastore information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Metastore`
Return type:	`Response`
Example:

Click here to see an example of how to use update_metastore API.

update_namespace(catalog_id, namespace_id, update_namespace_details, **kwargs)¶

Updates a specific namespace identified by the given key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. namespace_id (str) – (required) Unique namespace identifier. update_namespace_details (oci.data_catalog.models.UpdateNamespaceDetails) – (required) The information to be updated in the namespace. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Namespace`
Return type:	`Response`
Example:

Click here to see an example of how to use update_namespace API.

update_pattern(catalog_id, pattern_key, update_pattern_details, **kwargs)¶

Updates a specific pattern identified by the given key.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. pattern_key (str) – (required) Unique pattern key. update_pattern_details (oci.data_catalog.models.UpdatePatternDetails) – (required) The information to be updated in the pattern. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Pattern`
Return type:	`Response`
Example:

Click here to see an example of how to use update_pattern API.

update_term(catalog_id, glossary_key, term_key, update_term_details, **kwargs)¶

Updates a specific glossary term.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. term_key (str) – (required) Unique glossary term key. update_term_details (oci.data_catalog.models.UpdateTermDetails) – (required) The information to be updated in the term. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Term`
Return type:	`Response`
Example:

Click here to see an example of how to use update_term API.

update_term_relationship(catalog_id, glossary_key, term_key, term_relationship_key, update_term_relationship_details, **kwargs)¶

Updates a specific glossary term relationship.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. glossary_key (str) – (required) Unique glossary key. term_key (str) – (required) Unique glossary term key. term_relationship_key (str) – (required) Unique glossary term relationship key. update_term_relationship_details (oci.data_catalog.models.UpdateTermRelationshipDetails) – (required) The information to be updated in the term relationship. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TermRelationship`
Return type:	`Response`
Example:

Click here to see an example of how to use update_term_relationship API.

upload_credentials(catalog_id, data_asset_key, connection_key, upload_credentials_details, **kwargs)¶

Upload connection credentails and metadata for this connection.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. connection_key (str) – (required) Unique connection key. upload_credentials_details (oci.data_catalog.models.UploadCredentialsDetails) – (required) The information used to upload the credentials file and metadata for updating this connection. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use upload_credentials API.

users(catalog_id, **kwargs)¶

Returns active users in the system.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type str
Return type:	`Response`
Example:

Click here to see an example of how to use users API.

validate_connection(catalog_id, data_asset_key, validate_connection_details, **kwargs)¶

Validate connection by connecting to the data asset using credentials in metadata.

Parameters:	catalog_id (str) – (required) Unique catalog identifier. data_asset_key (str) – (required) Unique data asset key. validate_connection_details (oci.data_catalog.models.ValidateConnectionDetails) – (required) The information used to validate the connections. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ValidateConnectionResult`
Return type:	`Response`
Example:

Click here to see an example of how to use validate_connection API.

validate_pattern(catalog_id, pattern_key, validate_pattern_details, **kwargs)¶

Validate pattern by deriving file groups representing logical entities using the expression

Parameters:	catalog_id (str) – (required) Unique catalog identifier. pattern_key (str) – (required) Unique pattern key. validate_pattern_details (oci.data_catalog.models.ValidatePatternDetails) – (required) The information used to validate the pattern. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ValidatePatternResult`
Return type:	`Response`
Example:

Click here to see an example of how to use validate_pattern API.