DataAsset¶

class oci.data_catalog.models.DataAsset(**kwargs)¶

Bases: object

Data asset representation. A physical store, or stream, of data known to the data catalog and containing one or many data entities, possibly in an organized structure of folders. A data asset is often synonymous with a ‘System’, such as a database, or may be a file container or a message stream.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DataAsset.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DataAsset.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DataAsset.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DataAsset.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DataAsset.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DataAsset.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a DataAsset.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DataAsset.
`catalog_id`	Gets the catalog_id of this DataAsset.
`created_by_id`	Gets the created_by_id of this DataAsset.
`custom_property_members`	Gets the custom_property_members of this DataAsset.
`data_selector_patterns`	Gets the data_selector_patterns of this DataAsset.
`description`	Gets the description of this DataAsset.
`display_name`	Gets the display_name of this DataAsset.
`external_key`	Gets the external_key of this DataAsset.
`key`	[Required] Gets the key of this DataAsset.
`lifecycle_details`	Gets the lifecycle_details of this DataAsset.
`lifecycle_state`	Gets the lifecycle_state of this DataAsset.
`properties`	Gets the properties of this DataAsset.
`time_created`	Gets the time_created of this DataAsset.
`time_harvested`	Gets the time_harvested of this DataAsset.
`time_updated`	Gets the time_updated of this DataAsset.
`type_key`	Gets the type_key of this DataAsset.
`updated_by_id`	Gets the updated_by_id of this DataAsset.
`uri`	Gets the uri of this DataAsset.

Methods

__init__(**kwargs) Initializes a new DataAsset object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DataAsset. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DataAsset. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DataAsset. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DataAsset. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DataAsset. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DataAsset. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'¶: A constant which can be used with the lifecycle_state property of a DataAsset. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DataAsset. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new DataAsset object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

key (str) – The value to assign to the key property of this DataAsset.
display_name (str) – The value to assign to the display_name property of this DataAsset.
description (str) – The value to assign to the description property of this DataAsset.
catalog_id (str) – The value to assign to the catalog_id property of this DataAsset.
external_key (str) – The value to assign to the external_key property of this DataAsset.
type_key (str) – The value to assign to the type_key property of this DataAsset.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataAsset. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DataAsset.
time_created (datetime) – The value to assign to the time_created property of this DataAsset.
time_updated (datetime) – The value to assign to the time_updated property of this DataAsset.
time_harvested (datetime) – The value to assign to the time_harvested property of this DataAsset.
created_by_id (str) – The value to assign to the created_by_id property of this DataAsset.
updated_by_id (str) – The value to assign to the updated_by_id property of this DataAsset.
uri (str) – The value to assign to the uri property of this DataAsset.
custom_property_members (list[oci.data_catalog.models.CustomPropertyGetUsage]) – The value to assign to the custom_property_members property of this DataAsset.
data_selector_patterns (list[oci.data_catalog.models.PatternSummary]) – The value to assign to the data_selector_patterns property of this DataAsset.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this DataAsset.

catalog_id¶

Gets the catalog_id of this DataAsset. The data catalog’s OCID.

Returns:	The catalog_id of this DataAsset.
Return type:	str

created_by_id¶

Gets the created_by_id of this DataAsset. OCID of the user who created the data asset.

Returns:	The created_by_id of this DataAsset.
Return type:	str

custom_property_members¶

Gets the custom_property_members of this DataAsset. The list of customized properties along with the values for this object

Returns:	The custom_property_members of this DataAsset.
Return type:	list[oci.data_catalog.models.CustomPropertyGetUsage]

data_selector_patterns¶

Gets the data_selector_patterns of this DataAsset. The list of data selector patterns used in the harvest for this data asset to derive logical entities.

Returns:	The data_selector_patterns of this DataAsset.
Return type:	list[oci.data_catalog.models.PatternSummary]

description¶

Gets the description of this DataAsset. Detailed description of the data asset.

Returns:	The description of this DataAsset.
Return type:	str

display_name¶

Gets the display_name of this DataAsset. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this DataAsset.
Return type:	str

external_key¶

Gets the external_key of this DataAsset. External URI that can be used to reference the object. Format will differ based on the type of object.

Returns:	The external_key of this DataAsset.
Return type:	str

key¶

[Required] Gets the key of this DataAsset. Unique data asset key that is immutable.

Returns:	The key of this DataAsset.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this DataAsset. A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.

Returns:	The lifecycle_details of this DataAsset.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this DataAsset. The current state of the data asset.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DataAsset.
Return type:	str

properties¶

Gets the properties of this DataAsset. A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the “default” category. Example: {“properties”: { “default”: { “host”: “host1”, “port”: “1521”, “database”: “orcl”}}}

Returns:	The properties of this DataAsset.
Return type:	dict(str, dict(str, str))

time_created¶

Gets the time_created of this DataAsset. The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:	The time_created of this DataAsset.
Return type:	datetime

time_harvested¶

Gets the time_harvested of this DataAsset. The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

Returns:	The time_harvested of this DataAsset.
Return type:	datetime

time_updated¶

Gets the time_updated of this DataAsset. The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

Returns:	The time_updated of this DataAsset.
Return type:	datetime

type_key¶

Gets the type_key of this DataAsset. The key of the object type. Type key’s can be found via the ‘/types’ endpoint.

Returns:	The type_key of this DataAsset.
Return type:	str

updated_by_id¶

Gets the updated_by_id of this DataAsset. OCID of the user who last modified the data asset.

Returns:	The updated_by_id of this DataAsset.
Return type:	str

uri¶

Gets the uri of this DataAsset. URI to the data asset instance in the API.

Returns:	The uri of this DataAsset.
Return type:	str