FolderTag¶

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

Bases: object

Represents an association of a folder to a term.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a FolderTag.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a FolderTag.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a FolderTag.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a FolderTag.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a FolderTag.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a FolderTag.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a FolderTag.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a FolderTag.
`created_by_id`	Gets the created_by_id of this FolderTag.
`folder_key`	Gets the folder_key of this FolderTag.
`key`	[Required] Gets the key of this FolderTag.
`lifecycle_state`	Gets the lifecycle_state of this FolderTag.
`name`	Gets the name of this FolderTag.
`term_description`	Gets the term_description of this FolderTag.
`term_key`	Gets the term_key of this FolderTag.
`term_path`	Gets the term_path of this FolderTag.
`time_created`	Gets the time_created of this FolderTag.
`uri`	Gets the uri of this FolderTag.

Methods

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

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

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new FolderTag object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

folder_key (str) – The value to assign to the folder_key property of this FolderTag.
key (str) – The value to assign to the key property of this FolderTag.
name (str) – The value to assign to the name property of this FolderTag.
term_key (str) – The value to assign to the term_key property of this FolderTag.
term_path (str) – The value to assign to the term_path property of this FolderTag.
term_description (str) – The value to assign to the term_description property of this FolderTag.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this FolderTag. 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’.
time_created (datetime) – The value to assign to the time_created property of this FolderTag.
created_by_id (str) – The value to assign to the created_by_id property of this FolderTag.
uri (str) – The value to assign to the uri property of this FolderTag.

created_by_id¶

Gets the created_by_id of this FolderTag. OCID of the user who created the tag.

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

folder_key¶

Gets the folder_key of this FolderTag. The unique key of the folder associated with this tag.

Returns:	The folder_key of this FolderTag.
Return type:	str

key¶

[Required] Gets the key of this FolderTag. Unique tag key that is immutable.

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

lifecycle_state¶

Gets the lifecycle_state of this FolderTag. The current state of the tag.

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

name¶

Gets the name of this FolderTag. Name of the tag which matches the term name.

Returns:	The name of this FolderTag.
Return type:	str

term_description¶

Gets the term_description of this FolderTag. Description of the related term.

Returns:	The term_description of this FolderTag.
Return type:	str

term_key¶

Gets the term_key of this FolderTag. Unique key of the related term.

Returns:	The term_key of this FolderTag.
Return type:	str

term_path¶

Gets the term_path of this FolderTag. Path of the related term.

Returns:	The term_path of this FolderTag.
Return type:	str

time_created¶

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

Returns:	The time_created of this FolderTag.
Return type:	datetime

uri¶

Gets the uri of this FolderTag. URI to the tag instance in the API.

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