FolderSummary

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

Bases: object

Summary of a folder. A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a FolderSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a FolderSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a FolderSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a FolderSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a FolderSummary.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a FolderSummary.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a FolderSummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a FolderSummary.
business_name Gets the business_name of this FolderSummary.
data_asset_key Gets the data_asset_key of this FolderSummary.
description Gets the description of this FolderSummary.
display_name Gets the display_name of this FolderSummary.
external_key Gets the external_key of this FolderSummary.
key [Required] Gets the key of this FolderSummary.
lifecycle_state Gets the lifecycle_state of this FolderSummary.
parent_folder_key Gets the parent_folder_key of this FolderSummary.
path Gets the path of this FolderSummary.
time_created Gets the time_created of this FolderSummary.
time_external Gets the time_external of this FolderSummary.
type_key Gets the type_key of this FolderSummary.
uri Gets the uri of this FolderSummary.

Methods

__init__(**kwargs) Initializes a new FolderSummary object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new FolderSummary 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 FolderSummary.
  • display_name (str) – The value to assign to the display_name property of this FolderSummary.
  • business_name (str) – The value to assign to the business_name property of this FolderSummary.
  • description (str) – The value to assign to the description property of this FolderSummary.
  • data_asset_key (str) – The value to assign to the data_asset_key property of this FolderSummary.
  • parent_folder_key (str) – The value to assign to the parent_folder_key property of this FolderSummary.
  • type_key (str) – The value to assign to the type_key property of this FolderSummary.
  • path (str) – The value to assign to the path property of this FolderSummary.
  • external_key (str) – The value to assign to the external_key property of this FolderSummary.
  • time_external (datetime) – The value to assign to the time_external property of this FolderSummary.
  • time_created (datetime) – The value to assign to the time_created property of this FolderSummary.
  • uri (str) – The value to assign to the uri property of this FolderSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this FolderSummary. 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’.
business_name

Gets the business_name of this FolderSummary. Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.

Returns:The business_name of this FolderSummary.
Return type:str
data_asset_key

Gets the data_asset_key of this FolderSummary. The unique key of the parent data asset.

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

Gets the description of this FolderSummary. Detailed description of a folder.

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

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

Gets the external_key of this FolderSummary. Unique external key of this object from the source systems.

Returns:The external_key of this FolderSummary.
Return type:str
key

[Required] Gets the key of this FolderSummary. Unique folder key that is immutable.

Returns:The key of this FolderSummary.
Return type:str
lifecycle_state

Gets the lifecycle_state of this FolderSummary. State of the folder.

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 FolderSummary.
Return type:str
parent_folder_key

Gets the parent_folder_key of this FolderSummary. The key of the containing folder or null if there is no parent.

Returns:The parent_folder_key of this FolderSummary.
Return type:str
path

Gets the path of this FolderSummary. Full path of the folder.

Returns:The path of this FolderSummary.
Return type:str
time_created

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

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

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

Returns:The time_external of this FolderSummary.
Return type:datetime
type_key

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

Returns:The type_key of this FolderSummary.
Return type:str
uri

Gets the uri of this FolderSummary. URI of the folder resource within the data catalog API.

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