Term¶
- class oci.marketplace_publisher.models.Term(**kwargs)¶
Bases:
objectBase model object for the term.
Attributes:
A constant which can be used with the author property of a Term.
A constant which can be used with the author property of a Term.
A constant which can be used with the lifecycle_state property of a Term.
A constant which can be used with the lifecycle_state property of a Term.
[Required] Gets the author of this Term.
[Required] Gets the compartment_id of this Term.
Gets the defined_tags of this Term.
Gets the freeform_tags of this Term.
Gets the id of this Term.
[Required] Gets the lifecycle_state of this Term.
[Required] Gets the name of this Term.
[Required] Gets the publisher_id of this Term.
Gets the system_tags of this Term.
[Required] Gets the time_created of this Term.
[Required] Gets the time_updated of this Term.
Methods:
__init__(**kwargs)Initializes a new Term object with values from keyword arguments.
- AUTHOR_ORACLE = 'ORACLE'¶
A constant which can be used with the author property of a Term. This constant has a value of “ORACLE”
- AUTHOR_PARTNER = 'PARTNER'¶
A constant which can be used with the author property of a Term. This constant has a value of “PARTNER”
- 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_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Term. This constant has a value of “INACTIVE”
- __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
id (str) – The value to assign to the id property of this Term.
name (str) – The value to assign to the name property of this Term.
author (str) – The value to assign to the author property of this Term. Allowed values for this property are: “ORACLE”, “PARTNER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this Term.
publisher_id (str) – The value to assign to the publisher_id 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: “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 Term.
time_updated (datetime) – The value to assign to the time_updated property of this Term.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Term.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Term.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Term.
- property author¶
[Required] Gets the author of this Term. Who authored the term. Publisher terms will be defaulted to ‘PARTNER’.
Allowed values for this property are: “ORACLE”, “PARTNER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The author of this Term.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this Term. The unique identifier for the compartment.
- Returns
The compartment_id of this Term.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this Term. 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 Term.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this Term. 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 Term.
- Return type
dict(str, str)
- property id¶
Gets the id of this Term. Unique OCID identifier for the term.
- Returns
The id of this Term.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Term. The current state for the Term.
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 Term.
- Return type
str
- property name¶
[Required] Gets the name of this Term. The name for the term.
- Returns
The name of this Term.
- Return type
str
- property publisher_id¶
[Required] Gets the publisher_id of this Term. The unique identifier for the publisher.
- Returns
The publisher_id of this Term.
- Return type
str
- property system_tags¶
Gets the system_tags of this Term. 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 Term.
- Return type
dict(str, dict(str, object))