Term

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

Bases: object

Full term definition. 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. Nesting of terms to support a hierarchy is supported by default.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_MOVING

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

LIFECYCLE_STATE_UPDATING

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

WORKFLOW_STATUS_APPROVED

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

WORKFLOW_STATUS_ESCALATED

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

WORKFLOW_STATUS_NEW

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

WORKFLOW_STATUS_UNDER_REVIEW

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

associated_object_count

Gets the associated_object_count of this Term.

associated_objects

Gets the associated_objects of this Term.

created_by_id

Gets the created_by_id of this Term.

custom_property_members

Gets the custom_property_members of this Term.

description

Gets the description of this Term.

display_name

Gets the display_name of this Term.

glossary_key

Gets the glossary_key of this Term.

is_allowed_to_have_child_terms

Gets the is_allowed_to_have_child_terms of this Term.

key

[Required] Gets the key of this Term.

lifecycle_state

Gets the lifecycle_state of this Term.

owner

Gets the owner of this Term.

parent_term_key

Gets the parent_term_key of this Term.

path

Gets the path of this Term.

time_created

Gets the time_created of this Term.

time_updated

Gets the time_updated of this Term.

updated_by_id

Gets the updated_by_id of this Term.

uri

Gets the uri of this Term.

workflow_status

Gets the workflow_status of this Term.

Methods:

__init__(**kwargs)

Initializes a new Term object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

WORKFLOW_STATUS_APPROVED = 'APPROVED'

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

WORKFLOW_STATUS_ESCALATED = 'ESCALATED'

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

WORKFLOW_STATUS_NEW = 'NEW'

A constant which can be used with the workflow_status property of a Term. 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 Term. This constant has a value of “UNDER_REVIEW”

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

  • time_updated (datetime) – The value to assign to the time_updated property of this Term.

  • created_by_id (str) – The value to assign to the created_by_id property of this Term.

  • updated_by_id (str) – The value to assign to the updated_by_id property of this Term.

  • owner (str) – The value to assign to the owner property of this Term.

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

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

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

  • associated_objects (list[oci.data_catalog.models.TermAssociatedObject]) – The value to assign to the associated_objects property of this Term.

  • custom_property_members (list[oci.data_catalog.models.CustomPropertyGetUsage]) – The value to assign to the custom_property_members property of this Term.

property associated_object_count

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

Returns

The associated_object_count of this Term.

Return type

int

property associated_objects

Gets the associated_objects of this Term. Array of objects associated to a term.

Returns

The associated_objects of this Term.

Return type

list[oci.data_catalog.models.TermAssociatedObject]

property created_by_id

Gets the created_by_id of this Term. OCID of the user who created the term.

Returns

The created_by_id of this Term.

Return type

str

property custom_property_members

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

Returns

The custom_property_members of this Term.

Return type

list[oci.data_catalog.models.CustomPropertyGetUsage]

property description

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

Returns

The description of this Term.

Return type

str

property display_name

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

Return type

str

property glossary_key

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

Returns

The glossary_key of this Term.

Return type

str

property is_allowed_to_have_child_terms

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

Returns

The is_allowed_to_have_child_terms of this Term.

Return type

bool

property key

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

Returns

The key of this Term.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this Term. The current 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 Term.

Return type

str

property owner

Gets the owner of this Term. OCID of the user who is the owner of this business terminology.

Returns

The owner of this Term.

Return type

str

property parent_term_key

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

Returns

The parent_term_key of this Term.

Return type

str

property path

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

Returns

The path of this Term.

Return type

str

property time_created

Gets the time_created of this Term. 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 Term.

Return type

datetime

property time_updated

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

Returns

The time_updated of this Term.

Return type

datetime

property updated_by_id

Gets the updated_by_id of this Term. OCID of the user who modified the term.

Returns

The updated_by_id of this Term.

Return type

str

property uri

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

Returns

The uri of this Term.

Return type

str

property workflow_status

Gets the workflow_status of this Term. 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 Term.

Return type

str