TermSummary

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

Bases: object

Summary of a term. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be stated at the term level.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a TermSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a TermSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a TermSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a TermSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a TermSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a TermSummary.

LIFECYCLE_STATE_MOVING

A constant which can be used with the lifecycle_state property of a TermSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a TermSummary.

WORKFLOW_STATUS_APPROVED

A constant which can be used with the workflow_status property of a TermSummary.

WORKFLOW_STATUS_ESCALATED

A constant which can be used with the workflow_status property of a TermSummary.

WORKFLOW_STATUS_NEW

A constant which can be used with the workflow_status property of a TermSummary.

WORKFLOW_STATUS_UNDER_REVIEW

A constant which can be used with the workflow_status property of a TermSummary.

associated_object_count

Gets the associated_object_count of this TermSummary.

description

Gets the description of this TermSummary.

display_name

Gets the display_name of this TermSummary.

glossary_key

Gets the glossary_key of this TermSummary.

is_allowed_to_have_child_terms

Gets the is_allowed_to_have_child_terms of this TermSummary.

key

[Required] Gets the key of this TermSummary.

lifecycle_state

Gets the lifecycle_state of this TermSummary.

parent_term_key

Gets the parent_term_key of this TermSummary.

path

Gets the path of this TermSummary.

time_created

Gets the time_created of this TermSummary.

uri

Gets the uri of this TermSummary.

workflow_status

Gets the workflow_status of this TermSummary.

Methods:

__init__(**kwargs)

Initializes a new TermSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

WORKFLOW_STATUS_APPROVED = 'APPROVED'

A constant which can be used with the workflow_status property of a TermSummary. This constant has a value of “APPROVED”

WORKFLOW_STATUS_ESCALATED = 'ESCALATED'

A constant which can be used with the workflow_status property of a TermSummary. This constant has a value of “ESCALATED”

WORKFLOW_STATUS_NEW = 'NEW'

A constant which can be used with the workflow_status property of a TermSummary. This constant has a value of “NEW”

WORKFLOW_STATUS_UNDER_REVIEW = 'UNDER_REVIEW'

A constant which can be used with the workflow_status property of a TermSummary. This constant has a value of “UNDER_REVIEW”

__init__(**kwargs)

Initializes a new TermSummary 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 TermSummary.

  • display_name (str) – The value to assign to the display_name property of this TermSummary.

  • description (str) – The value to assign to the description property of this TermSummary.

  • glossary_key (str) – The value to assign to the glossary_key property of this TermSummary.

  • uri (str) – The value to assign to the uri property of this TermSummary.

  • parent_term_key (str) – The value to assign to the parent_term_key property of this TermSummary.

  • is_allowed_to_have_child_terms (bool) – The value to assign to the is_allowed_to_have_child_terms property of this TermSummary.

  • path (str) – The value to assign to the path property of this TermSummary.

  • time_created (datetime) – The value to assign to the time_created property of this TermSummary.

  • workflow_status (str) – The value to assign to the workflow_status property of this TermSummary. Allowed values for this property are: “NEW”, “APPROVED”, “UNDER_REVIEW”, “ESCALATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • associated_object_count (int) – The value to assign to the associated_object_count property of this TermSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this TermSummary. 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’.

property associated_object_count

Gets the associated_object_count of this TermSummary. The number of objects tagged with this term.

Returns

The associated_object_count of this TermSummary.

Return type

int

property description

Gets the description of this TermSummary. Detailed description of the term.

Returns

The description of this TermSummary.

Return type

str

property display_name

Gets the display_name of this TermSummary. 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 TermSummary.

Return type

str

property glossary_key

Gets the glossary_key of this TermSummary. Unique id of the parent glossary.

Returns

The glossary_key of this TermSummary.

Return type

str

property is_allowed_to_have_child_terms

Gets the is_allowed_to_have_child_terms of this TermSummary. Indicates whether a term may contain child terms.

Returns

The is_allowed_to_have_child_terms of this TermSummary.

Return type

bool

property key

[Required] Gets the key of this TermSummary. Unique term key that is immutable.

Returns

The key of this TermSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this TermSummary. State of the term.

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 TermSummary.

Return type

str

property parent_term_key

Gets the parent_term_key of this TermSummary. This terms parent term key. Will be null if the term has no parent term.

Returns

The parent_term_key of this TermSummary.

Return type

str

property path

Gets the path of this TermSummary. Absolute path of the term.

Returns

The path of this TermSummary.

Return type

str

property time_created

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

Returns

The time_created of this TermSummary.

Return type

datetime

property uri

Gets the uri of this TermSummary. URI to the term instance in the API.

Returns

The uri of this TermSummary.

Return type

str

property workflow_status

Gets the workflow_status of this TermSummary. Status of the approval process workflow for this business term in the glossary.

Allowed values for this property are: “NEW”, “APPROVED”, “UNDER_REVIEW”, “ESCALATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The workflow_status of this TermSummary.

Return type

str