CreateOsvcChannelResult¶

class oci.oda.models.CreateOsvcChannelResult(**kwargs)¶

Bases: oci.oda.models.create_channel_result.CreateChannelResult

The configuration for an OSVC channel.

Attributes

`CATEGORY_AGENT`	str(object=’’) -> str
`CATEGORY_APPLICATION`	str(object=’’) -> str
`CATEGORY_BOT`	str(object=’’) -> str
`CATEGORY_BOT_AS_AGENT`	str(object=’’) -> str
`CATEGORY_EVENT`	str(object=’’) -> str
`CATEGORY_SYSTEM`	str(object=’’) -> str
`CHANNEL_SERVICE_FUSION`	A constant which can be used with the channel_service property of a CreateOsvcChannelResult.
`CHANNEL_SERVICE_OSVC`	A constant which can be used with the channel_service property of a CreateOsvcChannelResult.
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_INACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`TYPE_ANDROID`	str(object=’’) -> str
`TYPE_APPEVENT`	str(object=’’) -> str
`TYPE_APPLICATION`	str(object=’’) -> str
`TYPE_CORTANA`	str(object=’’) -> str
`TYPE_FACEBOOK`	str(object=’’) -> str
`TYPE_IOS`	str(object=’’) -> str
`TYPE_MSTEAMS`	str(object=’’) -> str
`TYPE_OSS`	str(object=’’) -> str
`TYPE_OSVC`	str(object=’’) -> str
`TYPE_SERVICECLOUD`	str(object=’’) -> str
`TYPE_SLACK`	str(object=’’) -> str
`TYPE_TEST`	str(object=’’) -> str
`TYPE_TWILIO`	str(object=’’) -> str
`TYPE_WEB`	str(object=’’) -> str
`TYPE_WEBHOOK`	str(object=’’) -> str
`authentication_provider_name`	[Required] Gets the authentication_provider_name of this CreateOsvcChannelResult.
`bot_id`	Gets the bot_id of this CreateOsvcChannelResult.
`category`	[Required] Gets the category of this CreateChannelResult.
`channel_service`	[Required] Gets the channel_service of this CreateOsvcChannelResult.
`defined_tags`	Gets the defined_tags of this CreateChannelResult.
`description`	Gets the description of this CreateChannelResult.
`freeform_tags`	Gets the freeform_tags of this CreateChannelResult.
`host`	[Required] Gets the host of this CreateOsvcChannelResult.
`id`	[Required] Gets the id of this CreateChannelResult.
`lifecycle_state`	[Required] Gets the lifecycle_state of this CreateChannelResult.
`name`	[Required] Gets the name of this CreateChannelResult.
`port`	[Required] Gets the port of this CreateOsvcChannelResult.
`session_expiry_duration_in_milliseconds`	Gets the session_expiry_duration_in_milliseconds of this CreateChannelResult.
`time_created`	[Required] Gets the time_created of this CreateChannelResult.
`time_updated`	[Required] Gets the time_updated of this CreateChannelResult.
`total_session_count`	[Required] Gets the total_session_count of this CreateOsvcChannelResult.
`type`	[Required] Gets the type of this CreateChannelResult.
`user_name`	[Required] Gets the user_name of this CreateOsvcChannelResult.

Methods

`__init__`(**kwargs)	Initializes a new CreateOsvcChannelResult 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'¶

CATEGORY_APPLICATION = 'APPLICATION'¶

CATEGORY_BOT = 'BOT'¶

CATEGORY_BOT_AS_AGENT = 'BOT_AS_AGENT'¶

CATEGORY_EVENT = 'EVENT'¶

CATEGORY_SYSTEM = 'SYSTEM'¶

CHANNEL_SERVICE_FUSION = 'FUSION'¶: A constant which can be used with the channel_service property of a CreateOsvcChannelResult. This constant has a value of “FUSION”

CHANNEL_SERVICE_OSVC = 'OSVC'¶: A constant which can be used with the channel_service property of a CreateOsvcChannelResult. This constant has a value of “OSVC”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

TYPE_ANDROID = 'ANDROID'¶

TYPE_APPEVENT = 'APPEVENT'¶

TYPE_APPLICATION = 'APPLICATION'¶

TYPE_CORTANA = 'CORTANA'¶

TYPE_FACEBOOK = 'FACEBOOK'¶

TYPE_IOS = 'IOS'¶

TYPE_MSTEAMS = 'MSTEAMS'¶

TYPE_OSS = 'OSS'¶

TYPE_OSVC = 'OSVC'¶

TYPE_SERVICECLOUD = 'SERVICECLOUD'¶

TYPE_SLACK = 'SLACK'¶

TYPE_TEST = 'TEST'¶

TYPE_TWILIO = 'TWILIO'¶

TYPE_WEB = 'WEB'¶

TYPE_WEBHOOK = 'WEBHOOK'¶

__init__(**kwargs)¶

Initializes a new CreateOsvcChannelResult object with values from keyword arguments. The default value of the type attribute of this class is OSVC and 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 CreateOsvcChannelResult.
name (str) – The value to assign to the name property of this CreateOsvcChannelResult.
description (str) – The value to assign to the description property of this CreateOsvcChannelResult.
category (str) – The value to assign to the category property of this CreateOsvcChannelResult. 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 CreateOsvcChannelResult. 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 CreateOsvcChannelResult.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateOsvcChannelResult. 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 CreateOsvcChannelResult.
time_updated (datetime) – The value to assign to the time_updated property of this CreateOsvcChannelResult.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOsvcChannelResult.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOsvcChannelResult.
host (str) – The value to assign to the host property of this CreateOsvcChannelResult.
port (str) – The value to assign to the port property of this CreateOsvcChannelResult.
user_name (str) – The value to assign to the user_name property of this CreateOsvcChannelResult.
total_session_count (int) – The value to assign to the total_session_count property of this CreateOsvcChannelResult.
channel_service (str) – The value to assign to the channel_service property of this CreateOsvcChannelResult. Allowed values for this property are: “OSVC”, “FUSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
authentication_provider_name (str) – The value to assign to the authentication_provider_name property of this CreateOsvcChannelResult.
bot_id (str) – The value to assign to the bot_id property of this CreateOsvcChannelResult.

authentication_provider_name¶

[Required] Gets the authentication_provider_name of this CreateOsvcChannelResult. The name of the Authentication Provider to use to authenticate the user.

Returns:	The authentication_provider_name of this CreateOsvcChannelResult.
Return type:	str

bot_id¶

Gets the bot_id of this CreateOsvcChannelResult. The ID of the Skill or Digital Assistant that the Channel is routed to.

Returns:	The bot_id of this CreateOsvcChannelResult.
Return type:	str

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

channel_service¶

[Required] Gets the channel_service of this CreateOsvcChannelResult. The type of OSVC service.

Allowed values for this property are: “OSVC”, “FUSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The channel_service of this CreateOsvcChannelResult.
Return type:	str

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))

description¶

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

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

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.

host¶

[Required] Gets the host of this CreateOsvcChannelResult. The host.

For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com.

For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance’s URL. For example: sitename.exampledomain.com.

Returns:	The host of this CreateOsvcChannelResult.
Return type:	str

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

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

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

port¶

[Required] Gets the port of this CreateOsvcChannelResult. The port.

Returns:	The port of this CreateOsvcChannelResult.
Return type:	str

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

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

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

total_session_count¶

[Required] Gets the total_session_count of this CreateOsvcChannelResult. The total session count.

Returns:	The total_session_count of this CreateOsvcChannelResult.
Return type:	int

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

user_name¶

[Required] Gets the user_name of this CreateOsvcChannelResult. The user name for the digital-assistant agent.

Returns:	The user_name of this CreateOsvcChannelResult.
Return type:	str