ChannelSummary¶

class oci.mysql.models.ChannelSummary(**kwargs)¶

Bases: object

Summary of a Channel.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this ChannelSummary.
`defined_tags`	Gets the defined_tags of this ChannelSummary.
`display_name`	[Required] Gets the display_name of this ChannelSummary.
`freeform_tags`	Gets the freeform_tags of this ChannelSummary.
`id`	[Required] Gets the id of this ChannelSummary.
`is_enabled`	[Required] Gets the is_enabled of this ChannelSummary.
`lifecycle_details`	Gets the lifecycle_details of this ChannelSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ChannelSummary.
`source`	[Required] Gets the source of this ChannelSummary.
`target`	[Required] Gets the target of this ChannelSummary.
`time_created`	[Required] Gets the time_created of this ChannelSummary.
`time_updated`	[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.

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

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))

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

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)

id¶

[Required] Gets the id of this ChannelSummary. The OCID of the Channel.

Returns:	The id of this ChannelSummary.
Return type:	str

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

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

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

source¶

[Required] Gets the source of this ChannelSummary.

Returns:	The source of this ChannelSummary.
Return type:	oci.mysql.models.ChannelSource

target¶

[Required] Gets the target of this ChannelSummary.

Returns:	The target of this ChannelSummary.
Return type:	oci.mysql.models.ChannelTarget

time_created¶

[Required] Gets the time_created of this ChannelSummary. The date and time the Channel was created, as described by RFC 3339.

Returns:	The time_created of this ChannelSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ChannelSummary. The time the Channel was last updated, as described by RFC 3339.

Returns:	The time_updated of this ChannelSummary.
Return type:	datetime