FolderTagSummary¶

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

Bases: object

Summary of a folder tag.

Attributes

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

Methods

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

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

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new FolderTagSummary 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 FolderTagSummary.
key (str) – The value to assign to the key property of this FolderTagSummary.
time_created (datetime) – The value to assign to the time_created property of this FolderTagSummary.
name (str) – The value to assign to the name property of this FolderTagSummary.
uri (str) – The value to assign to the uri property of this FolderTagSummary.
term_key (str) – The value to assign to the term_key property of this FolderTagSummary.
term_path (str) – The value to assign to the term_path property of this FolderTagSummary.
term_description (str) – The value to assign to the term_description property of this FolderTagSummary.
glossary_key (str) – The value to assign to the glossary_key property of this FolderTagSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this FolderTagSummary. 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’.

folder_key¶

Gets the folder_key of this FolderTagSummary. The unique key of the parent folder.

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

glossary_key¶

Gets the glossary_key of this FolderTagSummary. Unique id of the parent glossary of the term.

Returns:	The glossary_key of this FolderTagSummary.
Return type:	str

key¶

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

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

lifecycle_state¶

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

name¶

Gets the name of this FolderTagSummary. Name of the tag that matches the term name.

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

term_description¶

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

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

term_key¶

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

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

term_path¶

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

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

time_created¶

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

uri¶

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

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