CreateTestChannelResult¶
- class oci.oda.models.CreateTestChannelResult(**kwargs)¶
Bases:
CreateChannelResultThe configuration for the Test channel.
Attributes:
A constant which can be used with the category property of a CreateChannelResult.
A constant which can be used with the category property of a CreateChannelResult.
A constant which can be used with the category property of a CreateChannelResult.
A constant which can be used with the category property of a CreateChannelResult.
A constant which can be used with the category property of a CreateChannelResult.
A constant which can be used with the category property of a CreateChannelResult.
A constant which can be used with the lifecycle_state property of a CreateChannelResult.
A constant which can be used with the lifecycle_state property of a CreateChannelResult.
A constant which can be used with the lifecycle_state property of a CreateChannelResult.
A constant which can be used with the lifecycle_state property of a CreateChannelResult.
A constant which can be used with the lifecycle_state property of a CreateChannelResult.
A constant which can be used with the lifecycle_state property of a CreateChannelResult.
A constant which can be used with the lifecycle_state property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
A constant which can be used with the type property of a CreateChannelResult.
[Required] Gets the category of this CreateChannelResult.
Gets the defined_tags of this CreateChannelResult.
Gets the description of this CreateChannelResult.
Gets the freeform_tags of this CreateChannelResult.
[Required] Gets the id of this CreateChannelResult.
[Required] Gets the lifecycle_state of this CreateChannelResult.
[Required] Gets the name of this CreateChannelResult.
Gets the secret_key of this CreateTestChannelResult.
Gets the session_expiry_duration_in_milliseconds of this CreateChannelResult.
[Required] Gets the time_created of this CreateChannelResult.
[Required] Gets the time_updated of this CreateChannelResult.
[Required] Gets the type of this CreateChannelResult.
[Required] Gets the webhook_url of this CreateTestChannelResult.
Methods:
__init__(**kwargs)Initializes a new CreateTestChannelResult 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 CreateChannelResult. This constant has a value of “AGENT”
- CATEGORY_APPLICATION = 'APPLICATION'¶
A constant which can be used with the category property of a CreateChannelResult. This constant has a value of “APPLICATION”
- CATEGORY_BOT = 'BOT'¶
A constant which can be used with the category property of a CreateChannelResult. 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 CreateChannelResult. This constant has a value of “BOT_AS_AGENT”
- CATEGORY_EVENT = 'EVENT'¶
A constant which can be used with the category property of a CreateChannelResult. This constant has a value of “EVENT”
- CATEGORY_SYSTEM = 'SYSTEM'¶
A constant which can be used with the category property of a CreateChannelResult. This constant has a value of “SYSTEM”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a CreateChannelResult. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a CreateChannelResult. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a CreateChannelResult. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a CreateChannelResult. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a CreateChannelResult. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a CreateChannelResult. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a CreateChannelResult. This constant has a value of “UPDATING”
- TYPE_ANDROID = 'ANDROID'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “ANDROID”
- TYPE_APPEVENT = 'APPEVENT'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “APPEVENT”
- TYPE_APPLICATION = 'APPLICATION'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “APPLICATION”
- TYPE_CORTANA = 'CORTANA'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “CORTANA”
- TYPE_FACEBOOK = 'FACEBOOK'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “FACEBOOK”
- TYPE_IOS = 'IOS'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “IOS”
- TYPE_MSTEAMS = 'MSTEAMS'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “MSTEAMS”
- TYPE_OSS = 'OSS'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “OSS”
- TYPE_OSVC = 'OSVC'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “OSVC”
- TYPE_SERVICECLOUD = 'SERVICECLOUD'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “SERVICECLOUD”
- TYPE_SLACK = 'SLACK'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “SLACK”
- TYPE_TEST = 'TEST'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “TEST”
- TYPE_TWILIO = 'TWILIO'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “TWILIO”
- TYPE_WEB = 'WEB'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “WEB”
- TYPE_WEBHOOK = 'WEBHOOK'¶
A constant which can be used with the type property of a CreateChannelResult. This constant has a value of “WEBHOOK”
- __init__(**kwargs)¶
Initializes a new CreateTestChannelResult object with values from keyword arguments. The default value of the
typeattribute of this class isTESTand it should not be changed. 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 CreateTestChannelResult.
name (str) – The value to assign to the name property of this CreateTestChannelResult.
description (str) – The value to assign to the description property of this CreateTestChannelResult.
category (str) – The value to assign to the category property of this CreateTestChannelResult. Allowed values for this property are: “AGENT”, “APPLICATION”, “BOT”, “BOT_AS_AGENT”, “SYSTEM”, “EVENT”
type (str) – The value to assign to the type property of this CreateTestChannelResult. Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”
session_expiry_duration_in_milliseconds (int) – The value to assign to the session_expiry_duration_in_milliseconds property of this CreateTestChannelResult.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateTestChannelResult. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”
time_created (datetime) – The value to assign to the time_created property of this CreateTestChannelResult.
time_updated (datetime) – The value to assign to the time_updated property of this CreateTestChannelResult.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateTestChannelResult.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateTestChannelResult.
secret_key (str) – The value to assign to the secret_key property of this CreateTestChannelResult.
webhook_url (str) – The value to assign to the webhook_url property of this CreateTestChannelResult.
- property category¶
[Required] Gets the category of this CreateChannelResult. 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 CreateChannelResult.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateChannelResult. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this CreateChannelResult.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateChannelResult. A short description of the Channel.
- Returns
The description of this CreateChannelResult.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateChannelResult. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this CreateChannelResult.
- 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.
- property id¶
[Required] Gets the id of this CreateChannelResult. Unique immutable identifier that was assigned when the Channel was created.
- Returns
The id of this CreateChannelResult.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this CreateChannelResult. 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 CreateChannelResult.
- Return type
str
- property name¶
[Required] Gets the name of this CreateChannelResult. 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 CreateChannelResult.
- Return type
str
- property secret_key¶
Gets the secret_key of this CreateTestChannelResult. The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key.
- Returns
The secret_key of this CreateTestChannelResult.
- Return type
str
- property session_expiry_duration_in_milliseconds¶
Gets the session_expiry_duration_in_milliseconds of this CreateChannelResult. The number of milliseconds before a session expires.
- Returns
The session_expiry_duration_in_milliseconds of this CreateChannelResult.
- Return type
int
- property time_created¶
[Required] Gets the time_created of this CreateChannelResult. When the resource was created. A date-time string as described in RFC 3339, section 14.29.
- Returns
The time_created of this CreateChannelResult.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this CreateChannelResult. When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
- Returns
The time_updated of this CreateChannelResult.
- Return type
datetime
- property type¶
[Required] Gets the type of this CreateChannelResult. 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 CreateChannelResult.
- Return type
str
- property webhook_url¶
[Required] Gets the webhook_url of this CreateTestChannelResult. The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
- Returns
The webhook_url of this CreateTestChannelResult.
- Return type
str