CreateTermDetails¶

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

Bases: object

Properties used in term create operations.

Attributes

`WORKFLOW_STATUS_APPROVED`	A constant which can be used with the workflow_status property of a CreateTermDetails.
`WORKFLOW_STATUS_ESCALATED`	A constant which can be used with the workflow_status property of a CreateTermDetails.
`WORKFLOW_STATUS_NEW`	A constant which can be used with the workflow_status property of a CreateTermDetails.
`WORKFLOW_STATUS_UNDER_REVIEW`	A constant which can be used with the workflow_status property of a CreateTermDetails.
`custom_property_members`	Gets the custom_property_members of this CreateTermDetails.
`description`	Gets the description of this CreateTermDetails.
`display_name`	[Required] Gets the display_name of this CreateTermDetails.
`is_allowed_to_have_child_terms`	Gets the is_allowed_to_have_child_terms of this CreateTermDetails.
`owner`	Gets the owner of this CreateTermDetails.
`parent_term_key`	Gets the parent_term_key of this CreateTermDetails.
`workflow_status`	Gets the workflow_status of this CreateTermDetails.

Methods

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

WORKFLOW_STATUS_APPROVED = 'APPROVED'¶: A constant which can be used with the workflow_status property of a CreateTermDetails. This constant has a value of “APPROVED”

WORKFLOW_STATUS_ESCALATED = 'ESCALATED'¶: A constant which can be used with the workflow_status property of a CreateTermDetails. This constant has a value of “ESCALATED”

WORKFLOW_STATUS_NEW = 'NEW'¶: A constant which can be used with the workflow_status property of a CreateTermDetails. 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 CreateTermDetails. This constant has a value of “UNDER_REVIEW”

__init__(**kwargs)¶

Initializes a new CreateTermDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateTermDetails.
description (str) – The value to assign to the description property of this CreateTermDetails.
is_allowed_to_have_child_terms (bool) – The value to assign to the is_allowed_to_have_child_terms property of this CreateTermDetails.
parent_term_key (str) – The value to assign to the parent_term_key property of this CreateTermDetails.
owner (str) – The value to assign to the owner property of this CreateTermDetails.
workflow_status (str) – The value to assign to the workflow_status property of this CreateTermDetails. Allowed values for this property are: “NEW”, “APPROVED”, “UNDER_REVIEW”, “ESCALATED”
custom_property_members (list[oci.data_catalog.models.CustomPropertySetUsage]) – The value to assign to the custom_property_members property of this CreateTermDetails.

custom_property_members¶

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

Returns:	The custom_property_members of this CreateTermDetails.
Return type:	list[oci.data_catalog.models.CustomPropertySetUsage]

description¶

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

Returns:	The description of this CreateTermDetails.
Return type:	str

display_name¶

[Required] Gets the display_name of this CreateTermDetails. A user-friendly display name. Is changeable. The combination of ‘displayName’ and ‘parentTermKey’ must be unique. Avoid entering confidential information.

Returns:	The display_name of this CreateTermDetails.
Return type:	str

is_allowed_to_have_child_terms¶

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

Returns:	The is_allowed_to_have_child_terms of this CreateTermDetails.
Return type:	bool

owner¶

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

Returns:	The owner of this CreateTermDetails.
Return type:	str

parent_term_key¶

Gets the parent_term_key of this CreateTermDetails. The parent key of the term. In the case of a root-level category only, the term would have no parent and this should be left unset.

Returns:	The parent_term_key of this CreateTermDetails.
Return type:	str

workflow_status¶

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

Allowed values for this property are: “NEW”, “APPROVED”, “UNDER_REVIEW”, “ESCALATED”

Returns:	The workflow_status of this CreateTermDetails.
Return type:	str