Entity

class oci.data_catalog.models.Entity(**kwargs)

Bases: object

Data entity details. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with ‘table’ or ‘view’ in a database, or a single logical file structure that one or many files may match.

Attributes

HARVEST_STATUS_COMPLETE A constant which can be used with the harvest_status property of a Entity.
HARVEST_STATUS_DEFERRED A constant which can be used with the harvest_status property of a Entity.
HARVEST_STATUS_ERROR A constant which can be used with the harvest_status property of a Entity.
HARVEST_STATUS_IN_PROGRESS A constant which can be used with the harvest_status property of a Entity.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Entity.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Entity.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Entity.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Entity.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Entity.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a Entity.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a Entity.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Entity.
created_by_id Gets the created_by_id of this Entity.
custom_property_members Gets the custom_property_members of this Entity.
data_asset_key Gets the data_asset_key of this Entity.
description Gets the description of this Entity.
display_name Gets the display_name of this Entity.
external_key Gets the external_key of this Entity.
folder_key Gets the folder_key of this Entity.
folder_name Gets the folder_name of this Entity.
harvest_status Gets the harvest_status of this Entity.
is_logical Gets the is_logical of this Entity.
is_partition Gets the is_partition of this Entity.
key [Required] Gets the key of this Entity.
last_job_key Gets the last_job_key of this Entity.
lifecycle_state Gets the lifecycle_state of this Entity.
path Gets the path of this Entity.
pattern_key Gets the pattern_key of this Entity.
properties Gets the properties of this Entity.
realized_expression Gets the realized_expression of this Entity.
time_created Gets the time_created of this Entity.
time_external Gets the time_external of this Entity.
time_status_updated Gets the time_status_updated of this Entity.
time_updated Gets the time_updated of this Entity.
type_key Gets the type_key of this Entity.
updated_by_id Gets the updated_by_id of this Entity.
uri Gets the uri of this Entity.

Methods

__init__(**kwargs) Initializes a new Entity object with values from keyword arguments.
HARVEST_STATUS_COMPLETE = 'COMPLETE'

A constant which can be used with the harvest_status property of a Entity. This constant has a value of “COMPLETE”

HARVEST_STATUS_DEFERRED = 'DEFERRED'

A constant which can be used with the harvest_status property of a Entity. This constant has a value of “DEFERRED”

HARVEST_STATUS_ERROR = 'ERROR'

A constant which can be used with the harvest_status property of a Entity. This constant has a value of “ERROR”

HARVEST_STATUS_IN_PROGRESS = 'IN_PROGRESS'

A constant which can be used with the harvest_status property of a Entity. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Entity. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Entity. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Entity. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Entity. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Entity. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Entity. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_state property of a Entity. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Entity. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Entity 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 Entity.
  • display_name (str) – The value to assign to the display_name property of this Entity.
  • description (str) – The value to assign to the description property of this Entity.
  • time_created (datetime) – The value to assign to the time_created property of this Entity.
  • time_updated (datetime) – The value to assign to the time_updated property of this Entity.
  • created_by_id (str) – The value to assign to the created_by_id property of this Entity.
  • updated_by_id (str) – The value to assign to the updated_by_id property of this Entity.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Entity. 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’.
  • external_key (str) – The value to assign to the external_key property of this Entity.
  • pattern_key (str) – The value to assign to the pattern_key property of this Entity.
  • realized_expression (str) – The value to assign to the realized_expression property of this Entity.
  • time_external (datetime) – The value to assign to the time_external property of this Entity.
  • time_status_updated (datetime) – The value to assign to the time_status_updated property of this Entity.
  • is_logical (bool) – The value to assign to the is_logical property of this Entity.
  • is_partition (bool) – The value to assign to the is_partition property of this Entity.
  • data_asset_key (str) – The value to assign to the data_asset_key property of this Entity.
  • folder_key (str) – The value to assign to the folder_key property of this Entity.
  • folder_name (str) – The value to assign to the folder_name property of this Entity.
  • path (str) – The value to assign to the path property of this Entity.
  • harvest_status (str) – The value to assign to the harvest_status property of this Entity. Allowed values for this property are: “COMPLETE”, “ERROR”, “IN_PROGRESS”, “DEFERRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • last_job_key (str) – The value to assign to the last_job_key property of this Entity.
  • type_key (str) – The value to assign to the type_key property of this Entity.
  • uri (str) – The value to assign to the uri property of this Entity.
  • custom_property_members (list[oci.data_catalog.models.CustomPropertyGetUsage]) – The value to assign to the custom_property_members property of this Entity.
  • properties (dict(str, dict(str, str))) – The value to assign to the properties property of this Entity.
created_by_id

Gets the created_by_id of this Entity. OCID of the user who created this object in the data catalog.

Returns:The created_by_id of this Entity.
Return type:str
custom_property_members

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

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

Gets the data_asset_key of this Entity. Unique key of the parent data asset.

Returns:The data_asset_key of this Entity.
Return type:str
description

Gets the description of this Entity. Detailed description of a data entity.

Returns:The description of this Entity.
Return type:str
display_name

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

Gets the external_key of this Entity. Unique external key of this object in the source system.

Returns:The external_key of this Entity.
Return type:str
folder_key

Gets the folder_key of this Entity. Key of the associated folder.

Returns:The folder_key of this Entity.
Return type:str
folder_name

Gets the folder_name of this Entity. Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.

Returns:The folder_name of this Entity.
Return type:str
harvest_status

Gets the harvest_status of this Entity. Status of the object as updated by the harvest process.

Allowed values for this property are: “COMPLETE”, “ERROR”, “IN_PROGRESS”, “DEFERRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The harvest_status of this Entity.
Return type:str
is_logical

Gets the is_logical of this Entity. Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.

Returns:The is_logical of this Entity.
Return type:bool
is_partition

Gets the is_partition of this Entity. Property that identifies if an object is a sub object of a physical or materialized parent object.

Returns:The is_partition of this Entity.
Return type:bool
key

[Required] Gets the key of this Entity. Unique data entity key that is immutable.

Returns:The key of this Entity.
Return type:str
last_job_key

Gets the last_job_key of this Entity. Key of the last harvest process to update this object.

Returns:The last_job_key of this Entity.
Return type:str
lifecycle_state

Gets the lifecycle_state of this Entity. The current state of the data entity.

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 Entity.
Return type:str
path

Gets the path of this Entity. Full path of the data entity.

Returns:The path of this Entity.
Return type:str
pattern_key

Gets the pattern_key of this Entity. Key of the associated pattern if this is a logical entity.

Returns:The pattern_key of this Entity.
Return type:str
properties

Gets the properties of this Entity. A map of maps that contains the properties which are specific to the entity type. Each entity 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 entities have required properties within the “default” category. Example: {“properties”: { “default”: { “key1”: “value1”}}}

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

Gets the realized_expression of this Entity. The expression realized after resolving qualifiers . Used in deriving this logical entity

Returns:The realized_expression of this Entity.
Return type:str
time_created

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

Returns:The time_created of this Entity.
Return type:datetime
time_external

Gets the time_external of this Entity. Last modified timestamp of this object in the external system.

Returns:The time_external of this Entity.
Return type:datetime
time_status_updated

Gets the time_status_updated of this Entity. Time that the data entities status was last updated. An RFC3339 formatted datetime string.

Returns:The time_status_updated of this Entity.
Return type:datetime
time_updated

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

Returns:The time_updated of this Entity.
Return type:datetime
type_key

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

Returns:The type_key of this Entity.
Return type:str
updated_by_id

Gets the updated_by_id of this Entity. OCID of the user who updated this object in the data catalog.

Returns:The updated_by_id of this Entity.
Return type:str
uri

Gets the uri of this Entity. URI to the data entity instance in the API.

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