ChannelSummary¶
- class oci.mysql.models.ChannelSummary(**kwargs)¶
Bases:
objectSummary of a Channel.
Methods:
__init__(**kwargs)Initializes a new ChannelSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this ChannelSummary.
Gets the defined_tags of this ChannelSummary.
[Required] Gets the display_name of this ChannelSummary.
Gets the freeform_tags of this ChannelSummary.
[Required] Gets the id of this ChannelSummary.
[Required] Gets the is_enabled of this ChannelSummary.
Gets the lifecycle_details of this ChannelSummary.
[Required] Gets the lifecycle_state of this ChannelSummary.
[Required] Gets the source of this ChannelSummary.
Gets the system_tags of this ChannelSummary.
[Required] Gets the target of this ChannelSummary.
[Required] Gets the time_created of this ChannelSummary.
[Required] Gets the time_updated of this ChannelSummary.
- __init__(**kwargs)¶
Initializes a new ChannelSummary 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 ChannelSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ChannelSummary.
is_enabled (bool) – The value to assign to the is_enabled property of this ChannelSummary.
source (oci.mysql.models.ChannelSource) – The value to assign to the source property of this ChannelSummary.
target (oci.mysql.models.ChannelTarget) – The value to assign to the target property of this ChannelSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ChannelSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ChannelSummary.
display_name (str) – The value to assign to the display_name property of this ChannelSummary.
time_created (datetime) – The value to assign to the time_created property of this ChannelSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ChannelSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ChannelSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ChannelSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ChannelSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this ChannelSummary. The OCID of the compartment.
- Returns
The compartment_id of this ChannelSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ChannelSummary. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this ChannelSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this ChannelSummary. The user-friendly name for the Channel. It does not have to be unique.
- Returns
The display_name of this ChannelSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ChannelSummary. Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this ChannelSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ChannelSummary. The OCID of the Channel.
- Returns
The id of this ChannelSummary.
- Return type
str
- property is_enabled¶
[Required] Gets the is_enabled of this ChannelSummary. Whether the Channel has been enabled by the user.
- Returns
The is_enabled of this ChannelSummary.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this ChannelSummary. A message describing the state of the Channel.
- Returns
The lifecycle_details of this ChannelSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ChannelSummary. The state of the Channel.
- Returns
The lifecycle_state of this ChannelSummary.
- Return type
str
- property source¶
[Required] Gets the source of this ChannelSummary.
- Returns
The source of this ChannelSummary.
- Return type
- property system_tags¶
Gets the system_tags of this ChannelSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this ChannelSummary.
- Return type
dict(str, dict(str, object))
- property target¶
[Required] Gets the target of this ChannelSummary.
- Returns
The target of this ChannelSummary.
- Return type