EntitySummary¶
-
class
oci.data_catalog.models.
EntitySummary
(**kwargs)¶ Bases:
object
Summary of an data entity. 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
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a EntitySummary. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a EntitySummary. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a EntitySummary. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a EntitySummary. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a EntitySummary. LIFECYCLE_STATE_INACTIVE
A constant which can be used with the lifecycle_state property of a EntitySummary. LIFECYCLE_STATE_MOVING
A constant which can be used with the lifecycle_state property of a EntitySummary. LIFECYCLE_STATE_UPDATING
A constant which can be used with the lifecycle_state property of a EntitySummary. data_asset_key
Gets the data_asset_key of this EntitySummary. description
Gets the description of this EntitySummary. display_name
Gets the display_name of this EntitySummary. external_key
Gets the external_key of this EntitySummary. folder_key
Gets the folder_key of this EntitySummary. folder_name
Gets the folder_name of this EntitySummary. key
[Required] Gets the key of this EntitySummary. lifecycle_state
Gets the lifecycle_state of this EntitySummary. path
Gets the path of this EntitySummary. pattern_key
Gets the pattern_key of this EntitySummary. realized_expression
Gets the realized_expression of this EntitySummary. time_created
Gets the time_created of this EntitySummary. time_updated
Gets the time_updated of this EntitySummary. updated_by_id
Gets the updated_by_id of this EntitySummary. uri
Gets the uri of this EntitySummary. Methods
__init__
(**kwargs)Initializes a new EntitySummary object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a EntitySummary. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a EntitySummary. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a EntitySummary. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a EntitySummary. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a EntitySummary. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_INACTIVE
= 'INACTIVE'¶ A constant which can be used with the lifecycle_state property of a EntitySummary. This constant has a value of “INACTIVE”
-
LIFECYCLE_STATE_MOVING
= 'MOVING'¶ A constant which can be used with the lifecycle_state property of a EntitySummary. This constant has a value of “MOVING”
-
LIFECYCLE_STATE_UPDATING
= 'UPDATING'¶ A constant which can be used with the lifecycle_state property of a EntitySummary. This constant has a value of “UPDATING”
-
__init__
(**kwargs)¶ Initializes a new EntitySummary 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 EntitySummary.
- display_name (str) – The value to assign to the display_name property of this EntitySummary.
- description (str) – The value to assign to the description property of this EntitySummary.
- data_asset_key (str) – The value to assign to the data_asset_key property of this EntitySummary.
- folder_key (str) – The value to assign to the folder_key property of this EntitySummary.
- folder_name (str) – The value to assign to the folder_name property of this EntitySummary.
- external_key (str) – The value to assign to the external_key property of this EntitySummary.
- pattern_key (str) – The value to assign to the pattern_key property of this EntitySummary.
- realized_expression (str) – The value to assign to the realized_expression property of this EntitySummary.
- path (str) – The value to assign to the path property of this EntitySummary.
- time_created (datetime) – The value to assign to the time_created property of this EntitySummary.
- time_updated (datetime) – The value to assign to the time_updated property of this EntitySummary.
- updated_by_id (str) – The value to assign to the updated_by_id property of this EntitySummary.
- uri (str) – The value to assign to the uri property of this EntitySummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this EntitySummary. 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’.
-
data_asset_key
¶ Gets the data_asset_key of this EntitySummary. Unique key of the parent data asset.
Returns: The data_asset_key of this EntitySummary. Return type: str
-
description
¶ Gets the description of this EntitySummary. Detailed description of a data entity.
Returns: The description of this EntitySummary. Return type: str
-
display_name
¶ Gets the display_name of this EntitySummary. 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 EntitySummary. Return type: str
-
external_key
¶ Gets the external_key of this EntitySummary. Unique external key of this object in the source system.
Returns: The external_key of this EntitySummary. Return type: str
-
folder_key
¶ Gets the folder_key of this EntitySummary. Key of the associated folder.
Returns: The folder_key of this EntitySummary. Return type: str
-
folder_name
¶ Gets the folder_name of this EntitySummary. 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 EntitySummary. Return type: str
-
key
¶ [Required] Gets the key of this EntitySummary. Unique data entity key that is immutable.
Returns: The key of this EntitySummary. Return type: str
-
lifecycle_state
¶ Gets the lifecycle_state of this EntitySummary. 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 EntitySummary. Return type: str
-
path
¶ Gets the path of this EntitySummary. Full path of the data entity.
Returns: The path of this EntitySummary. Return type: str
-
pattern_key
¶ Gets the pattern_key of this EntitySummary. Key of the associated pattern if this is a logical entity.
Returns: The pattern_key of this EntitySummary. Return type: str
-
realized_expression
¶ Gets the realized_expression of this EntitySummary. The expression realized after resolving qualifiers . Used in deriving this logical entity
Returns: The realized_expression of this EntitySummary. Return type: str
-
time_created
¶ Gets the time_created of this EntitySummary. 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 EntitySummary. Return type: datetime
-
time_updated
¶ Gets the time_updated of this EntitySummary. The last time that any change was made to the data entity. An RFC3339 formatted datetime string.
Returns: The time_updated of this EntitySummary. Return type: datetime
-
updated_by_id
¶ Gets the updated_by_id of this EntitySummary. OCID of the user who updated this object in the data catalog.
Returns: The updated_by_id of this EntitySummary. Return type: str
-
uri
¶ Gets the uri of this EntitySummary. URI to the data entity instance in the API.
Returns: The uri of this EntitySummary. Return type: str
-