Channel

class oci.oda.models.Channel(**kwargs)

Bases: object

Properties of a Channel.

Attributes

CATEGORY_AGENT	A constant which can be used with the category property of a Channel.
CATEGORY_APPLICATION	A constant which can be used with the category property of a Channel.
CATEGORY_BOT	A constant which can be used with the category property of a Channel.
CATEGORY_BOT_AS_AGENT	A constant which can be used with the category property of a Channel.
CATEGORY_EVENT	A constant which can be used with the category property of a Channel.
CATEGORY_SYSTEM	A constant which can be used with the category property of a Channel.
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_UPDATING	A constant which can be used with the lifecycle_state property of a Channel.
TYPE_ANDROID	A constant which can be used with the type property of a Channel.
TYPE_APPEVENT	A constant which can be used with the type property of a Channel.
TYPE_APPLICATION	A constant which can be used with the type property of a Channel.
TYPE_CORTANA	A constant which can be used with the type property of a Channel.
TYPE_FACEBOOK	A constant which can be used with the type property of a Channel.
TYPE_IOS	A constant which can be used with the type property of a Channel.
TYPE_MSTEAMS	A constant which can be used with the type property of a Channel.
TYPE_OSS	A constant which can be used with the type property of a Channel.
TYPE_OSVC	A constant which can be used with the type property of a Channel.
TYPE_SERVICECLOUD	A constant which can be used with the type property of a Channel.
TYPE_SLACK	A constant which can be used with the type property of a Channel.
TYPE_TEST	A constant which can be used with the type property of a Channel.
TYPE_TWILIO	A constant which can be used with the type property of a Channel.
TYPE_WEB	A constant which can be used with the type property of a Channel.
TYPE_WEBHOOK	A constant which can be used with the type property of a Channel.
category	[Required] Gets the category of this Channel.
defined_tags	Gets the defined_tags of this Channel.
description	Gets the description of this Channel.
freeform_tags	Gets the freeform_tags of this Channel.
id	[Required] Gets the id of this Channel.
lifecycle_state	[Required] Gets the lifecycle_state of this Channel.
name	[Required] Gets the name of this Channel.
session_expiry_duration_in_milliseconds	Gets the session_expiry_duration_in_milliseconds of this Channel.
time_created	[Required] Gets the time_created of this Channel.
time_updated	[Required] Gets the time_updated of this Channel.
type	[Required] Gets the type of this Channel.

Methods

__init__(**kwargs)	Initializes a new Channel object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CATEGORY_AGENT = 'AGENT'

A constant which can be used with the category property of a Channel. This constant has a value of “AGENT”

CATEGORY_APPLICATION = 'APPLICATION'

A constant which can be used with the category property of a Channel. This constant has a value of “APPLICATION”

CATEGORY_BOT = 'BOT'

A constant which can be used with the category property of a Channel. This constant has a value of “BOT”

CATEGORY_BOT_AS_AGENT = 'BOT_AS_AGENT'

A constant which can be used with the category property of a Channel. This constant has a value of “BOT_AS_AGENT”

CATEGORY_EVENT = 'EVENT'

A constant which can be used with the category property of a Channel. This constant has a value of “EVENT”

CATEGORY_SYSTEM = 'SYSTEM'

A constant which can be used with the category property of a Channel. This constant has a value of “SYSTEM”

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_UPDATING = 'UPDATING'

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

TYPE_ANDROID = 'ANDROID'

A constant which can be used with the type property of a Channel. This constant has a value of “ANDROID”

TYPE_APPEVENT = 'APPEVENT'

A constant which can be used with the type property of a Channel. This constant has a value of “APPEVENT”

TYPE_APPLICATION = 'APPLICATION'

A constant which can be used with the type property of a Channel. This constant has a value of “APPLICATION”

TYPE_CORTANA = 'CORTANA'

A constant which can be used with the type property of a Channel. This constant has a value of “CORTANA”

TYPE_FACEBOOK = 'FACEBOOK'

A constant which can be used with the type property of a Channel. This constant has a value of “FACEBOOK”

TYPE_IOS = 'IOS'

A constant which can be used with the type property of a Channel. This constant has a value of “IOS”

TYPE_MSTEAMS = 'MSTEAMS'

A constant which can be used with the type property of a Channel. This constant has a value of “MSTEAMS”

TYPE_OSS = 'OSS'

A constant which can be used with the type property of a Channel. This constant has a value of “OSS”

TYPE_OSVC = 'OSVC'

A constant which can be used with the type property of a Channel. This constant has a value of “OSVC”

TYPE_SERVICECLOUD = 'SERVICECLOUD'

A constant which can be used with the type property of a Channel. This constant has a value of “SERVICECLOUD”

TYPE_SLACK = 'SLACK'

A constant which can be used with the type property of a Channel. This constant has a value of “SLACK”

TYPE_TEST = 'TEST'

A constant which can be used with the type property of a Channel. This constant has a value of “TEST”

TYPE_TWILIO = 'TWILIO'

A constant which can be used with the type property of a Channel. This constant has a value of “TWILIO”

TYPE_WEB = 'WEB'

A constant which can be used with the type property of a Channel. This constant has a value of “WEB”

TYPE_WEBHOOK = 'WEBHOOK'

A constant which can be used with the type property of a Channel. This constant has a value of “WEBHOOK”

__init__(**kwargs)

Initializes a new Channel object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• AppEventChannel
• FacebookChannel
• WebChannel
• MSTeamsChannel
• TwilioChannel
• OsvcChannel
• AndroidChannel
• OSSChannel
• WebhookChannel
• ApplicationChannel
• SlackChannel
• CortanaChannel
• ServiceCloudChannel
• IosChannel
• TestChannel

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.
• name (str) – The value to assign to the name property of this Channel.
• description (str) – The value to assign to the description property of this Channel.
• category (str) – The value to assign to the category property of this Channel. Allowed values for this property are: “AGENT”, “APPLICATION”, “BOT”, “BOT_AS_AGENT”, “SYSTEM”, “EVENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
• type (str) – The value to assign to the type property of this Channel. Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
• session_expiry_duration_in_milliseconds (int) – The value to assign to the session_expiry_duration_in_milliseconds 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”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘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 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.

category

[Required] Gets the category of this Channel. The category of the Channel.

Allowed values for this property are: “AGENT”, “APPLICATION”, “BOT”, “BOT_AS_AGENT”, “SYSTEM”, “EVENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The category 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. A short description of the Channel.

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

freeform_tags

Gets the freeform_tags of this Channel. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}

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

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id

[Required] Gets the id of this Channel. Unique immutable identifier that was assigned when the Channel was created.

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

lifecycle_state

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

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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

name

[Required] Gets the name of this Channel. The Channel’s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.

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

session_expiry_duration_in_milliseconds

Gets the session_expiry_duration_in_milliseconds of this Channel. The number of milliseconds before a session expires.

Returns:The session_expiry_duration_in_milliseconds of this Channel. Return type:int

time_created

[Required] Gets the time_created of this Channel. When the resource was created. A date-time string as described in RFC 3339, section 14.29.

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

time_updated

[Required] Gets the time_updated of this Channel. When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

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

type

[Required] Gets the type of this Channel. The Channel type.

Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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