ChannelSummary

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

Bases: object

Summary of the Channel.

Attributes:

CATEGORY_AGENT

A constant which can be used with the category property of a ChannelSummary.

CATEGORY_APPLICATION

A constant which can be used with the category property of a ChannelSummary.

CATEGORY_BOT

A constant which can be used with the category property of a ChannelSummary.

CATEGORY_BOT_AS_AGENT

A constant which can be used with the category property of a ChannelSummary.

CATEGORY_EVENT

A constant which can be used with the category property of a ChannelSummary.

CATEGORY_SYSTEM

A constant which can be used with the category property of a ChannelSummary.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a ChannelSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a ChannelSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a ChannelSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a ChannelSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a ChannelSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a ChannelSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a ChannelSummary.

TYPE_ANDROID

A constant which can be used with the type property of a ChannelSummary.

TYPE_APPEVENT

A constant which can be used with the type property of a ChannelSummary.

TYPE_APPLICATION

A constant which can be used with the type property of a ChannelSummary.

TYPE_CORTANA

A constant which can be used with the type property of a ChannelSummary.

TYPE_FACEBOOK

A constant which can be used with the type property of a ChannelSummary.

TYPE_IOS

A constant which can be used with the type property of a ChannelSummary.

TYPE_MSTEAMS

A constant which can be used with the type property of a ChannelSummary.

TYPE_OSS

A constant which can be used with the type property of a ChannelSummary.

TYPE_OSVC

A constant which can be used with the type property of a ChannelSummary.

TYPE_SERVICECLOUD

A constant which can be used with the type property of a ChannelSummary.

TYPE_SLACK

A constant which can be used with the type property of a ChannelSummary.

TYPE_TEST

A constant which can be used with the type property of a ChannelSummary.

TYPE_TWILIO

A constant which can be used with the type property of a ChannelSummary.

TYPE_WEB

A constant which can be used with the type property of a ChannelSummary.

TYPE_WEBHOOK

A constant which can be used with the type property of a ChannelSummary.

category

[Required] Gets the category of this ChannelSummary.

defined_tags

Gets the defined_tags of this ChannelSummary.

description

Gets the description of this ChannelSummary.

freeform_tags

Gets the freeform_tags of this ChannelSummary.

id

[Required] Gets the id of this ChannelSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this ChannelSummary.

name

[Required] Gets the name of this ChannelSummary.

time_created

[Required] Gets the time_created of this ChannelSummary.

time_updated

[Required] Gets the time_updated of this ChannelSummary.

type

[Required] Gets the type of this ChannelSummary.

Methods:

__init__(**kwargs)

Initializes a new ChannelSummary object with values from keyword arguments.

CATEGORY_AGENT = 'AGENT'

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

CATEGORY_APPLICATION = 'APPLICATION'

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

CATEGORY_BOT = 'BOT'

A constant which can be used with the category property of a ChannelSummary. 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 ChannelSummary. This constant has a value of “BOT_AS_AGENT”

CATEGORY_EVENT = 'EVENT'

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

CATEGORY_SYSTEM = 'SYSTEM'

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

TYPE_ANDROID = 'ANDROID'

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

TYPE_APPEVENT = 'APPEVENT'

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

TYPE_APPLICATION = 'APPLICATION'

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

TYPE_CORTANA = 'CORTANA'

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

TYPE_FACEBOOK = 'FACEBOOK'

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

TYPE_IOS = 'IOS'

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

TYPE_MSTEAMS = 'MSTEAMS'

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

TYPE_OSS = 'OSS'

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

TYPE_OSVC = 'OSVC'

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

TYPE_SERVICECLOUD = 'SERVICECLOUD'

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

TYPE_SLACK = 'SLACK'

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

TYPE_TEST = 'TEST'

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

TYPE_TWILIO = 'TWILIO'

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

TYPE_WEB = 'WEB'

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

TYPE_WEBHOOK = 'WEBHOOK'

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

__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.

  • name (str) – The value to assign to the name property of this ChannelSummary.

  • description (str) – The value to assign to the description property of this ChannelSummary.

  • category (str) – The value to assign to the category property of this ChannelSummary. 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 ChannelSummary. 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’.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ChannelSummary. 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 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.

property category

[Required] Gets the category of this ChannelSummary. 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 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 description

Gets the description of this ChannelSummary. A short description of the Channel.

Returns

The description of this ChannelSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this ChannelSummary. Simple key-value pair that is applied without any predefined name, type, or scope. 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. Unique immutable identifier that was assigned when the Channel was created.

Returns

The id of this ChannelSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this ChannelSummary. 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 ChannelSummary.

Return type

str

property name

[Required] Gets the name of this ChannelSummary. 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 ChannelSummary.

Return type

str

property time_created

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

Returns

The time_created of this ChannelSummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this ChannelSummary.

Return type

datetime

property type

[Required] Gets the type of this ChannelSummary. 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 ChannelSummary.

Return type

str