DataAssetSummary¶

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

Bases: object

Summary of a data asset. 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 DataAssetSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DataAssetSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DataAssetSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DataAssetSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DataAssetSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DataAssetSummary.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a DataAssetSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DataAssetSummary.
`catalog_id`	Gets the catalog_id of this DataAssetSummary.
`description`	Gets the description of this DataAssetSummary.
`display_name`	Gets the display_name of this DataAssetSummary.
`external_key`	Gets the external_key of this DataAssetSummary.
`key`	[Required] Gets the key of this DataAssetSummary.
`lifecycle_details`	Gets the lifecycle_details of this DataAssetSummary.
`lifecycle_state`	Gets the lifecycle_state of this DataAssetSummary.
`time_created`	Gets the time_created of this DataAssetSummary.
`type_key`	Gets the type_key of this DataAssetSummary.
`uri`	Gets the uri of this DataAssetSummary.

Methods

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

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

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new DataAssetSummary 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 DataAssetSummary.
display_name (str) – The value to assign to the display_name property of this DataAssetSummary.
description (str) – The value to assign to the description property of this DataAssetSummary.
catalog_id (str) – The value to assign to the catalog_id property of this DataAssetSummary.
external_key (str) – The value to assign to the external_key property of this DataAssetSummary.
uri (str) – The value to assign to the uri property of this DataAssetSummary.
time_created (datetime) – The value to assign to the time_created property of this DataAssetSummary.
type_key (str) – The value to assign to the type_key property of this DataAssetSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataAssetSummary. 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 DataAssetSummary.

catalog_id¶

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

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

description¶

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

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

display_name¶

Gets the display_name of this DataAssetSummary. 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 DataAssetSummary.
Return type:	str

external_key¶

Gets the external_key of this DataAssetSummary. 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 DataAssetSummary.
Return type:	str

key¶

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

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

lifecycle_details¶

Gets the lifecycle_details of this DataAssetSummary. 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 DataAssetSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this DataAssetSummary. 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 DataAssetSummary.
Return type:	str

time_created¶

Gets the time_created of this DataAssetSummary. 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 DataAssetSummary.
Return type:	datetime

type_key¶

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

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

uri¶

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

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