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.

Methods

__init__(config, **kwargs) Creates a new service client
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.
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_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_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_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_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.
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.
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_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_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_glossary(catalog_id, glossary_key, …) Import the glossary and the terms from csv or json files and return the imported glossary resource.
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_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_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_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.
search_criteria(catalog_id, **kwargs) Returns a list of search results within a data catalog.
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_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_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.
__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.

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 (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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 (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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 (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Attribute

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AttributeTag

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_catalog_private_endpoint(create_catalog_private_endpoint_details, **kwargs)

Create a new private reverse connection endpoint.

Parameters:
  • create_catalog_private_endpoint_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Connection

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAsset

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAssetTag

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Entity

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EntityTag

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Folder

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FolderTag

Return type:

Response

create_glossary(catalog_id, create_glossary_details, **kwargs)

Creates a new glossary.

Parameters:
  • catalog_id (str) – (required) Unique catalog identifier.
  • create_glossary_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Glossary

Return type:

Response

create_job(catalog_id, create_job_details, **kwargs)

Creates a new job.

Parameters:
  • catalog_id (str) – (required) Unique catalog identifier.
  • create_job_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Job

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobDefinition

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobExecution

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Term

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TermRelationship

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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 (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of GlossaryTreeElement

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type str

Return type:

Response

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

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Attribute

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AttributeTag

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Catalog

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CatalogPrivateEndpoint

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Connection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAsset

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAssetTag

Return type:

Response

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Entity

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EntityTag

Return type:

Response

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Folder

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FolderTag

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Glossary

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Job

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobDefinition

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobExecution

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobLog

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobMetric

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Term

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TermRelationship

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Type

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequest

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Connection

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AttributeTagCollection

Return type:

Response

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.
  • 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”.
  • 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”, “isNullable”, “uri”, “path”, “minCollectionCount”, “maxCollectionCount”, “datatypeEntityKey”, “externalDatatypeEntityKey”, “parentAttributeKey”, “externalParentAttributeKey”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AttributeCollection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CatalogPrivateEndpointSummary

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CatalogSummary

Return type:

Response

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”.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConnectionCollection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAssetTagCollection

Return type:

Response

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”.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAssetCollection

Return type:

Response

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.
  • 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”.
  • 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.
  • 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. 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EntityCollection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EntityTagCollection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FolderTagCollection

Return type:

Response

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

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FolderCollection

Return type:

Response

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”.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type GlossaryCollection

Return type:

Response

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”.
  • job_execution_state (str) –

    (optional) Job execution state.

    Allowed values are: “CREATED”, “IN_PROGRESS”, “INACTIVE”, “FAILED”, “SUCCEEDED”, “CANCELED”

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

  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobDefinitionCollection

Return type:

Response

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”

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

  • 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. 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobExecutionCollection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobLogCollection

Return type:

Response

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”.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobMetricCollection

Return type:

Response

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

  • job_definition_key (str) – (optional) Unique job definition key.
  • schedule_cron_expression (str) – (optional) Schedule specified in the cron expression format that has seven fields for second, minute, hour, day-of-month, month, day-of-week, year. It can also include special characters like * for all and ? for any. There are also pre-defined schedules that can be specified using special strings. For example, @hourly will run the job every hour.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobCollection

Return type:

Response

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”.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TermCollection

Return type:

Response

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”.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TermRelationshipCollection

Return type:

Response

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”.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TermCollection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TypeCollection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequestError

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequestLog

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequest

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type str

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ConnectionAliasSummary

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SearchResultCollection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ValidateConnectionResult

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Attribute

Return type:

Response

update_catalog(catalog_id, update_catalog_details, **kwargs)

Updates the data catalog.

Parameters:
  • catalog_id (str) – (required) Unique catalog identifier.
  • update_catalog_details (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Catalog

Return type:

Response

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 (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Connection

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAsset

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Entity

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Folder

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Glossary

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Job

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type JobDefinition

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Term

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TermRelationship

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Connection

Return type:

Response

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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type str

Return type:

Response

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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ValidateConnectionResult

Return type:

Response