Channel¶

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

Bases: object

A Channel connecting a DB System to an external entity.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Channel.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Channel.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Channel.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Channel.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Channel.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Channel.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a Channel.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Channel.
`compartment_id`	[Required] Gets the compartment_id of this Channel.
`defined_tags`	Gets the defined_tags of this Channel.
`description`	Gets the description of this Channel.
`display_name`	[Required] Gets the display_name of this Channel.
`freeform_tags`	Gets the freeform_tags of this Channel.
`id`	[Required] Gets the id of this Channel.
`is_enabled`	[Required] Gets the is_enabled of this Channel.
`lifecycle_details`	Gets the lifecycle_details of this Channel.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Channel.
`source`	[Required] Gets the source of this Channel.
`system_tags`	Gets the system_tags of this Channel.
`target`	[Required] Gets the target of this Channel.
`time_created`	[Required] Gets the time_created of this Channel.
`time_updated`	[Required] Gets the time_updated of this Channel.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Channel. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Channel. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Channel. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Channel. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Channel. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Channel. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a Channel. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Channel. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new Channel 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 Channel.
compartment_id (str) – The value to assign to the compartment_id property of this Channel.
display_name (str) – The value to assign to the display_name property of this Channel.
is_enabled (bool) – The value to assign to the is_enabled property of this Channel.
source (oci.mysql.models.ChannelSource) – The value to assign to the source property of this Channel.
target (oci.mysql.models.ChannelTarget) – The value to assign to the target property of this Channel.
description (str) – The value to assign to the description property of this Channel.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Channel. Allowed values for this property are: “CREATING”, “ACTIVE”, “NEEDS_ATTENTION”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Channel.
time_created (datetime) – The value to assign to the time_created property of this Channel.
time_updated (datetime) – The value to assign to the time_updated property of this Channel.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Channel.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Channel.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Channel.

compartment_id¶

[Required] Gets the compartment_id of this Channel. The OCID of the compartment.

Returns:	The compartment_id of this Channel.
Return type:	str

defined_tags¶

Gets the defined_tags of this Channel. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this Channel.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this Channel. User provided description of the Channel.

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

display_name¶

[Required] Gets the display_name of this Channel. The user-friendly name for the Channel. It does not have to be unique.

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

freeform_tags¶

Gets the freeform_tags of this Channel. 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 Channel.
Return type:	dict(str, str)

id¶

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

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

is_enabled¶

[Required] Gets the is_enabled of this Channel. Whether the Channel has been enabled by the user.

Returns:	The is_enabled of this Channel.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this Channel. A message describing the state of the Channel.

Returns:	The lifecycle_details of this Channel.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Channel. The state of the Channel.

Allowed values for this property are: “CREATING”, “ACTIVE”, “NEEDS_ATTENTION”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Channel.
Return type:	str

source¶

[Required] Gets the source of this Channel.

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

system_tags¶

Gets the system_tags of this Channel. 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 Channel.
Return type:	dict(str, dict(str, object))

target¶

[Required] Gets the target of this Channel.

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

time_created¶

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

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

time_updated¶

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

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