TermRelationshipSummary¶
- class oci.data_catalog.models.TermRelationshipSummary(**kwargs)¶
Bases:
objectSummary of a term relationship. Business term relationship between two terms in a business glossary.
Attributes:
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary.
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary.
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary.
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary.
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary.
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary.
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary.
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary.
Gets the description of this TermRelationshipSummary.
Gets the display_name of this TermRelationshipSummary.
[Required] Gets the key of this TermRelationshipSummary.
Gets the lifecycle_state of this TermRelationshipSummary.
Gets the parent_term_description of this TermRelationshipSummary.
Gets the parent_term_display_name of this TermRelationshipSummary.
Gets the parent_term_glossary_key of this TermRelationshipSummary.
Gets the parent_term_key of this TermRelationshipSummary.
Gets the parent_term_path of this TermRelationshipSummary.
Gets the related_term_description of this TermRelationshipSummary.
Gets the related_term_display_name of this TermRelationshipSummary.
Gets the related_term_glossary_key of this TermRelationshipSummary.
Gets the related_term_key of this TermRelationshipSummary.
Gets the related_term_path of this TermRelationshipSummary.
Gets the time_created of this TermRelationshipSummary.
Gets the uri of this TermRelationshipSummary.
Methods:
__init__(**kwargs)Initializes a new TermRelationshipSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_MOVING = 'MOVING'¶
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary. This constant has a value of “MOVING”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a TermRelationshipSummary. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new TermRelationshipSummary 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 TermRelationshipSummary.
display_name (str) – The value to assign to the display_name property of this TermRelationshipSummary.
description (str) – The value to assign to the description property of this TermRelationshipSummary.
related_term_key (str) – The value to assign to the related_term_key property of this TermRelationshipSummary.
related_term_display_name (str) – The value to assign to the related_term_display_name property of this TermRelationshipSummary.
related_term_description (str) – The value to assign to the related_term_description property of this TermRelationshipSummary.
related_term_path (str) – The value to assign to the related_term_path property of this TermRelationshipSummary.
related_term_glossary_key (str) – The value to assign to the related_term_glossary_key property of this TermRelationshipSummary.
uri (str) – The value to assign to the uri property of this TermRelationshipSummary.
parent_term_key (str) – The value to assign to the parent_term_key property of this TermRelationshipSummary.
parent_term_display_name (str) – The value to assign to the parent_term_display_name property of this TermRelationshipSummary.
parent_term_description (str) – The value to assign to the parent_term_description property of this TermRelationshipSummary.
parent_term_path (str) – The value to assign to the parent_term_path property of this TermRelationshipSummary.
parent_term_glossary_key (str) – The value to assign to the parent_term_glossary_key property of this TermRelationshipSummary.
time_created (datetime) – The value to assign to the time_created property of this TermRelationshipSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TermRelationshipSummary. 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 description¶
Gets the description of this TermRelationshipSummary. Detailed description of the term relationship usually defined at the time of creation.
- Returns
The description of this TermRelationshipSummary.
- Return type
str
- property display_name¶
Gets the display_name of this TermRelationshipSummary. 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 TermRelationshipSummary.
- Return type
str
- property key¶
[Required] Gets the key of this TermRelationshipSummary. Unique term relationship key that is immutable.
- Returns
The key of this TermRelationshipSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this TermRelationshipSummary. 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 TermRelationshipSummary.
- Return type
str
- property parent_term_description¶
Gets the parent_term_description of this TermRelationshipSummary. Description of the parent term.
- Returns
The parent_term_description of this TermRelationshipSummary.
- Return type
str
- property parent_term_display_name¶
Gets the parent_term_display_name of this TermRelationshipSummary. Name of the parent term.
- Returns
The parent_term_display_name of this TermRelationshipSummary.
- Return type
str
- property parent_term_glossary_key¶
Gets the parent_term_glossary_key of this TermRelationshipSummary. Glossary key of the parent term.
- Returns
The parent_term_glossary_key of this TermRelationshipSummary.
- Return type
str
- property parent_term_key¶
Gets the parent_term_key of this TermRelationshipSummary. This relationships parent term key.
- Returns
The parent_term_key of this TermRelationshipSummary.
- Return type
str
- property parent_term_path¶
Gets the parent_term_path of this TermRelationshipSummary. Full path of the parent term.
- Returns
The parent_term_path of this TermRelationshipSummary.
- Return type
str
Gets the related_term_description of this TermRelationshipSummary. Description of the related term.
- Returns
The related_term_description of this TermRelationshipSummary.
- Return type
str
Gets the related_term_display_name of this TermRelationshipSummary. Name of the related term.
- Returns
The related_term_display_name of this TermRelationshipSummary.
- Return type
str
Gets the related_term_glossary_key of this TermRelationshipSummary. Glossary key of the related term.
- Returns
The related_term_glossary_key of this TermRelationshipSummary.
- Return type
str
Gets the related_term_key of this TermRelationshipSummary. Unique id of the related term.
- Returns
The related_term_key of this TermRelationshipSummary.
- Return type
str
Gets the related_term_path of this TermRelationshipSummary. Full path of the related term.
- Returns
The related_term_path of this TermRelationshipSummary.
- Return type
str
- property time_created¶
Gets the time_created of this TermRelationshipSummary. 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 TermRelationshipSummary.
- Return type
datetime
- property uri¶
Gets the uri of this TermRelationshipSummary. URI to the term relationship instance in the API.
- Returns
The uri of this TermRelationshipSummary.
- Return type
str