TermRelationship

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

Bases: object

Full term relationship definition. Business term relationship between two terms in a business glossary.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a TermRelationship.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a TermRelationship.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a TermRelationship.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a TermRelationship.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a TermRelationship.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a TermRelationship.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a TermRelationship.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a TermRelationship.
description Gets the description of this TermRelationship.
display_name Gets the display_name of this TermRelationship.
key [Required] Gets the key of this TermRelationship.
lifecycle_state Gets the lifecycle_state of this TermRelationship.
parent_term_description Gets the parent_term_description of this TermRelationship.
parent_term_display_name Gets the parent_term_display_name of this TermRelationship.
parent_term_key Gets the parent_term_key of this TermRelationship.
parent_term_path Gets the parent_term_path of this TermRelationship.
related_term_description Gets the related_term_description of this TermRelationship.
related_term_display_name Gets the related_term_display_name of this TermRelationship.
related_term_key Gets the related_term_key of this TermRelationship.
related_term_path Gets the related_term_path of this TermRelationship.
time_created Gets the time_created of this TermRelationship.
uri Gets the uri of this TermRelationship.

Methods

__init__(**kwargs) Initializes a new TermRelationship object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new TermRelationship 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 TermRelationship.
  • display_name (str) – The value to assign to the display_name property of this TermRelationship.
  • description (str) – The value to assign to the description property of this TermRelationship.
  • related_term_key (str) – The value to assign to the related_term_key property of this TermRelationship.
  • related_term_display_name (str) – The value to assign to the related_term_display_name property of this TermRelationship.
  • related_term_description (str) – The value to assign to the related_term_description property of this TermRelationship.
  • related_term_path (str) – The value to assign to the related_term_path property of this TermRelationship.
  • uri (str) – The value to assign to the uri property of this TermRelationship.
  • parent_term_key (str) – The value to assign to the parent_term_key property of this TermRelationship.
  • parent_term_display_name (str) – The value to assign to the parent_term_display_name property of this TermRelationship.
  • parent_term_description (str) – The value to assign to the parent_term_description property of this TermRelationship.
  • parent_term_path (str) – The value to assign to the parent_term_path property of this TermRelationship.
  • time_created (datetime) – The value to assign to the time_created property of this TermRelationship.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this TermRelationship. 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’.
description

Gets the description of this TermRelationship. Detailed description of the term relationship usually defined at the time of creation.

Returns:The description of this TermRelationship.
Return type:str
display_name

Gets the display_name of this TermRelationship. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.This is the same as relationshipType for termRelationship

Returns:The display_name of this TermRelationship.
Return type:str
key

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

Returns:The key of this TermRelationship.
Return type:str
lifecycle_state

Gets the lifecycle_state of this TermRelationship. State of the term relationship.

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

Gets the parent_term_description of this TermRelationship. Description of the parent term.

Returns:The parent_term_description of this TermRelationship.
Return type:str
parent_term_display_name

Gets the parent_term_display_name of this TermRelationship. Name of the parent term.

Returns:The parent_term_display_name of this TermRelationship.
Return type:str
parent_term_key

Gets the parent_term_key of this TermRelationship. This relationships parent term key.

Returns:The parent_term_key of this TermRelationship.
Return type:str
parent_term_path

Gets the parent_term_path of this TermRelationship. Full path of the parent term.

Returns:The parent_term_path of this TermRelationship.
Return type:str
related_term_description

Gets the related_term_description of this TermRelationship. Description of the related term.

Returns:The related_term_description of this TermRelationship.
Return type:str
related_term_display_name

Gets the related_term_display_name of this TermRelationship. Name of the related term.

Returns:The related_term_display_name of this TermRelationship.
Return type:str
related_term_key

Gets the related_term_key of this TermRelationship. Unique id of the related term.

Returns:The related_term_key of this TermRelationship.
Return type:str
related_term_path

Gets the related_term_path of this TermRelationship. Full path of the related term.

Returns:The related_term_path of this TermRelationship.
Return type:str
time_created

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

Returns:The time_created of this TermRelationship.
Return type:datetime
uri

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

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