Folder¶

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

Bases: object

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

`HARVEST_STATUS_COMPLETE`	A constant which can be used with the harvest_status property of a Folder.
`HARVEST_STATUS_DEFERRED`	A constant which can be used with the harvest_status property of a Folder.
`HARVEST_STATUS_ERROR`	A constant which can be used with the harvest_status property of a Folder.
`HARVEST_STATUS_IN_PROGRESS`	A constant which can be used with the harvest_status property of a Folder.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Folder.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Folder.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Folder.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Folder.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Folder.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Folder.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a Folder.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Folder.
`business_name`	Gets the business_name of this Folder.
`created_by_id`	Gets the created_by_id of this Folder.
`custom_property_members`	Gets the custom_property_members of this Folder.
`data_asset_key`	Gets the data_asset_key of this Folder.
`description`	Gets the description of this Folder.
`display_name`	Gets the display_name of this Folder.
`external_key`	Gets the external_key of this Folder.
`harvest_status`	Gets the harvest_status of this Folder.
`key`	[Required] Gets the key of this Folder.
`last_job_key`	Gets the last_job_key of this Folder.
`lifecycle_details`	Gets the lifecycle_details of this Folder.
`lifecycle_state`	Gets the lifecycle_state of this Folder.
`object_relationships`	Gets the object_relationships of this Folder.
`object_storage_url`	Gets the object_storage_url of this Folder.
`parent_folder_key`	Gets the parent_folder_key of this Folder.
`path`	Gets the path of this Folder.
`properties`	Gets the properties of this Folder.
`time_created`	Gets the time_created of this Folder.
`time_external`	Gets the time_external of this Folder.
`time_harvested`	Gets the time_harvested of this Folder.
`time_updated`	Gets the time_updated of this Folder.
`type_key`	Gets the type_key of this Folder.
`updated_by_id`	Gets the updated_by_id of this Folder.
`uri`	Gets the uri of this Folder.

Methods

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

HARVEST_STATUS_COMPLETE = 'COMPLETE'¶: A constant which can be used with the harvest_status property of a Folder. This constant has a value of “COMPLETE”

HARVEST_STATUS_DEFERRED = 'DEFERRED'¶: A constant which can be used with the harvest_status property of a Folder. This constant has a value of “DEFERRED”

HARVEST_STATUS_ERROR = 'ERROR'¶: A constant which can be used with the harvest_status property of a Folder. 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 Folder. 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 Folder. This constant has a value of “ACTIVE”

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new Folder 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 Folder.
display_name (str) – The value to assign to the display_name property of this Folder.
business_name (str) – The value to assign to the business_name property of this Folder.
description (str) – The value to assign to the description property of this Folder.
parent_folder_key (str) – The value to assign to the parent_folder_key property of this Folder.
type_key (str) – The value to assign to the type_key property of this Folder.
time_harvested (datetime) – The value to assign to the time_harvested property of this Folder.
object_relationships (list[oci.data_catalog.models.ObjectRelationship]) – The value to assign to the object_relationships property of this Folder.
path (str) – The value to assign to the path property of this Folder.
data_asset_key (str) – The value to assign to the data_asset_key property of this Folder.
custom_property_members (list[oci.data_catalog.models.CustomPropertyGetUsage]) – The value to assign to the custom_property_members property of this Folder.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this Folder.
external_key (str) – The value to assign to the external_key property of this Folder.
time_created (datetime) – The value to assign to the time_created property of this Folder.
time_updated (datetime) – The value to assign to the time_updated property of this Folder.
created_by_id (str) – The value to assign to the created_by_id property of this Folder.
updated_by_id (str) – The value to assign to the updated_by_id property of this Folder.
time_external (datetime) – The value to assign to the time_external property of this Folder.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Folder.
harvest_status (str) – The value to assign to the harvest_status property of this Folder. 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 Folder.
uri (str) – The value to assign to the uri property of this Folder.
object_storage_url (str) – The value to assign to the object_storage_url property of this Folder.

business_name¶

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

created_by_id¶

Gets the created_by_id of this Folder. OCID of the user who created the folder.

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

custom_property_members¶

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

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

data_asset_key¶

Gets the data_asset_key of this Folder. The key of the associated data asset.

Returns:	The data_asset_key of this Folder.
Return type:	str

description¶

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

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

display_name¶

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

external_key¶

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

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

harvest_status¶

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

key¶

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

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

last_job_key¶

Gets the last_job_key of this Folder. The key of the last harvest process to update the metadata of this object.

Returns:	The last_job_key of this Folder.
Return type:	str

lifecycle_details¶

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

lifecycle_state¶

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

object_relationships¶

Gets the object_relationships of this Folder. List of objects and their relationships to this folder.

Returns:	The object_relationships of this Folder.
Return type:	list[oci.data_catalog.models.ObjectRelationship]

object_storage_url¶

Gets the object_storage_url of this Folder. URL of the folder in the object store.

Returns:	The object_storage_url of this Folder.
Return type:	str

parent_folder_key¶

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

Returns:	The parent_folder_key of this Folder.
Return type:	str

path¶

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

Returns:	The path of this Folder.
Return type:	str

properties¶

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

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

time_created¶

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

time_external¶

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

Returns:	The time_external of this Folder.
Return type:	datetime

time_harvested¶

Gets the time_harvested of this Folder. The date and time the folder was harvested, in the format defined by RFC3339.

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

time_updated¶

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

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

type_key¶

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

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

updated_by_id¶

Gets the updated_by_id of this Folder. OCID of the user who modified the folder.

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

uri¶

Gets the uri of this Folder. URI to the folder instance in the API.

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