CreateChannelDetails¶

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

Bases: object

Details required to create a Channel.

Methods:

__init__(**kwargs)

Initializes a new CreateChannelDetails object with values from keyword arguments.

Attributes:

`compartment_id`	Gets the compartment_id of this CreateChannelDetails.
`defined_tags`	Gets the defined_tags of this CreateChannelDetails.
`description`	Gets the description of this CreateChannelDetails.
`display_name`	Gets the display_name of this CreateChannelDetails.
`freeform_tags`	Gets the freeform_tags of this CreateChannelDetails.
`is_enabled`	Gets the is_enabled of this CreateChannelDetails.
`source`	[Required] Gets the source of this CreateChannelDetails.
`target`	[Required] Gets the target of this CreateChannelDetails.

__init__(**kwargs)¶

Initializes a new CreateChannelDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

compartment_id (str) – The value to assign to the compartment_id property of this CreateChannelDetails.
display_name (str) – The value to assign to the display_name property of this CreateChannelDetails.
is_enabled (bool) – The value to assign to the is_enabled property of this CreateChannelDetails.
source (oci.mysql.models.CreateChannelSourceDetails) – The value to assign to the source property of this CreateChannelDetails.
target (oci.mysql.models.CreateChannelTargetDetails) – The value to assign to the target property of this CreateChannelDetails.
description (str) – The value to assign to the description property of this CreateChannelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateChannelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateChannelDetails.

property compartment_id¶

Gets the compartment_id of this CreateChannelDetails. The OCID of the compartment.

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

property defined_tags¶

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

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

property description¶

Gets the description of this CreateChannelDetails. User provided information about the Channel.

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

property display_name¶

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

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

property freeform_tags¶

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

property is_enabled¶

Gets the is_enabled of this CreateChannelDetails. Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.

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

property source¶

[Required] Gets the source of this CreateChannelDetails.

Returns: The source of this CreateChannelDetails.
Return type: oci.mysql.models.CreateChannelSourceDetails

property target¶

[Required] Gets the target of this CreateChannelDetails.

Returns: The target of this CreateChannelDetails.
Return type: oci.mysql.models.CreateChannelTargetDetails