TermVersion¶
- class oci.marketplace_publisher.models.TermVersion(**kwargs)¶
Bases:
objectModel object for the term version details.
Attributes:
A constant which can be used with the lifecycle_state property of a TermVersion.
A constant which can be used with the lifecycle_state property of a TermVersion.
A constant which can be used with the status property of a TermVersion.
A constant which can be used with the status property of a TermVersion.
A constant which can be used with the status property of a TermVersion.
[Required] Gets the attachment of this TermVersion.
Gets the author of this TermVersion.
Gets the compartment_id of this TermVersion.
Gets the defined_tags of this TermVersion.
[Required] Gets the display_name of this TermVersion.
Gets the freeform_tags of this TermVersion.
Gets the id of this TermVersion.
[Required] Gets the lifecycle_state of this TermVersion.
[Required] Gets the status of this TermVersion.
Gets the system_tags of this TermVersion.
[Required] Gets the term_author of this TermVersion.
[Required] Gets the term_id of this TermVersion.
[Required] Gets the time_created of this TermVersion.
[Required] Gets the time_updated of this TermVersion.
Methods:
__init__(**kwargs)Initializes a new TermVersion object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a TermVersion. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a TermVersion. This constant has a value of “INACTIVE”
- STATUS_AVAILABLE = 'AVAILABLE'¶
A constant which can be used with the status property of a TermVersion. This constant has a value of “AVAILABLE”
- STATUS_DELETED = 'DELETED'¶
A constant which can be used with the status property of a TermVersion. This constant has a value of “DELETED”
- STATUS_NOT_AVAILABLE = 'NOT_AVAILABLE'¶
A constant which can be used with the status property of a TermVersion. This constant has a value of “NOT_AVAILABLE”
- __init__(**kwargs)¶
Initializes a new TermVersion object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this TermVersion.
term_id (str) – The value to assign to the term_id property of this TermVersion.
term_author (str) – The value to assign to the term_author property of this TermVersion.
display_name (str) – The value to assign to the display_name property of this TermVersion.
compartment_id (str) – The value to assign to the compartment_id property of this TermVersion.
attachment (oci.marketplace_publisher.models.TermVersionAttachment) – The value to assign to the attachment property of this TermVersion.
status (str) – The value to assign to the status property of this TermVersion. Allowed values for this property are: “AVAILABLE”, “NOT_AVAILABLE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
author (str) – The value to assign to the author property of this TermVersion.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TermVersion. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘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 TermVersion.
time_updated (datetime) – The value to assign to the time_updated property of this TermVersion.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TermVersion.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TermVersion.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this TermVersion.
- property attachment¶
[Required] Gets the attachment of this TermVersion.
- Returns
The attachment of this TermVersion.
- Return type
- property author¶
Gets the author of this TermVersion. Who authored the term. Publisher terms will be defaulted to ‘PARTNER’.
- Returns
The author of this TermVersion.
- Return type
str
- property compartment_id¶
Gets the compartment_id of this TermVersion. The unique identifier for the compartment.
- Returns
The compartment_id of this TermVersion.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this TermVersion. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this TermVersion.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this TermVersion. The name for the term version.
- Returns
The display_name of this TermVersion.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this TermVersion. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this TermVersion.
- Return type
dict(str, str)
- property id¶
Gets the id of this TermVersion. Unique OCID identifier for the term version.
- Returns
The id of this TermVersion.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this TermVersion. The current state for the term version.
Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this TermVersion.
- Return type
str
- property status¶
[Required] Gets the status of this TermVersion. The current status for the term version.
Allowed values for this property are: “AVAILABLE”, “NOT_AVAILABLE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this TermVersion.
- Return type
str
- property system_tags¶
Gets the system_tags of this TermVersion. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this TermVersion.
- Return type
dict(str, dict(str, object))
- property term_author¶
[Required] Gets the term_author of this TermVersion. Who authored the term. Publisher terms will be defaulted to ‘PARTNER’.
- Returns
The term_author of this TermVersion.
- Return type
str
- property term_id¶
[Required] Gets the term_id of this TermVersion. The unique identifier for the term.
- Returns
The term_id of this TermVersion.
- Return type
str