CreateOSSChannelDetails¶

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

Bases: oci.oda.models.create_channel_details.CreateChannelDetails

Properties required to create an Oracle Streaming Service (OSS) channel.

Attributes

`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
`auth_token`	[Required] Gets the auth_token of this CreateOSSChannelDetails.
`bootstrap_servers`	[Required] Gets the bootstrap_servers of this CreateOSSChannelDetails.
`defined_tags`	Gets the defined_tags of this CreateChannelDetails.
`description`	Gets the description of this CreateChannelDetails.
`event_sink_bot_ids`	Gets the event_sink_bot_ids of this CreateOSSChannelDetails.
`freeform_tags`	Gets the freeform_tags of this CreateChannelDetails.
`inbound_message_topic`	[Required] Gets the inbound_message_topic of this CreateOSSChannelDetails.
`name`	[Required] Gets the name of this CreateChannelDetails.
`outbound_message_topic`	[Required] Gets the outbound_message_topic of this CreateOSSChannelDetails.
`sasl_mechanism`	[Required] Gets the sasl_mechanism of this CreateOSSChannelDetails.
`security_protocol`	[Required] Gets the security_protocol of this CreateOSSChannelDetails.
`session_expiry_duration_in_milliseconds`	Gets the session_expiry_duration_in_milliseconds of this CreateChannelDetails.
`stream_pool_id`	[Required] Gets the stream_pool_id of this CreateOSSChannelDetails.
`tenancy_name`	[Required] Gets the tenancy_name of this CreateOSSChannelDetails.
`type`	[Required] Gets the type of this CreateChannelDetails.
`user_name`	[Required] Gets the user_name of this CreateOSSChannelDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateOSSChannelDetails 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.

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 CreateOSSChannelDetails object with values from keyword arguments. The default value of the type attribute of this class is OSS and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this CreateOSSChannelDetails.
description (str) – The value to assign to the description property of this CreateOSSChannelDetails.
type (str) – The value to assign to the type property of this CreateOSSChannelDetails. 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 CreateOSSChannelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOSSChannelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOSSChannelDetails.
event_sink_bot_ids (list[str]) – The value to assign to the event_sink_bot_ids property of this CreateOSSChannelDetails.
inbound_message_topic (str) – The value to assign to the inbound_message_topic property of this CreateOSSChannelDetails.
outbound_message_topic (str) – The value to assign to the outbound_message_topic property of this CreateOSSChannelDetails.
bootstrap_servers (str) – The value to assign to the bootstrap_servers property of this CreateOSSChannelDetails.
security_protocol (str) – The value to assign to the security_protocol property of this CreateOSSChannelDetails.
sasl_mechanism (str) – The value to assign to the sasl_mechanism property of this CreateOSSChannelDetails.
tenancy_name (str) – The value to assign to the tenancy_name property of this CreateOSSChannelDetails.
user_name (str) – The value to assign to the user_name property of this CreateOSSChannelDetails.
stream_pool_id (str) – The value to assign to the stream_pool_id property of this CreateOSSChannelDetails.
auth_token (str) – The value to assign to the auth_token property of this CreateOSSChannelDetails.

auth_token¶

[Required] Gets the auth_token of this CreateOSSChannelDetails. The authentication token to use when connecting to the Oracle Streaming Service.

Returns:	The auth_token of this CreateOSSChannelDetails.
Return type:	str

bootstrap_servers¶

[Required] Gets the bootstrap_servers of this CreateOSSChannelDetails. The Oracle Streaming Service bootstrap servers.

Returns:	The bootstrap_servers of this CreateOSSChannelDetails.
Return type:	str

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

description¶

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

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

event_sink_bot_ids¶

Gets the event_sink_bot_ids of this CreateOSSChannelDetails. The IDs of the Skills and Digital Assistants that the Channel is routed to.

Returns:	The event_sink_bot_ids of this CreateOSSChannelDetails.
Return type:	list[str]

freeform_tags¶

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

Returns:	The freeform_tags of this CreateChannelDetails.
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.

inbound_message_topic¶

[Required] Gets the inbound_message_topic of this CreateOSSChannelDetails. The topic inbound messages are received on.

Returns:	The inbound_message_topic of this CreateOSSChannelDetails.
Return type:	str

name¶

[Required] Gets the name of this CreateChannelDetails. 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 CreateChannelDetails.
Return type:	str

outbound_message_topic¶

[Required] Gets the outbound_message_topic of this CreateOSSChannelDetails. The topic outbound messages are sent on.

Returns:	The outbound_message_topic of this CreateOSSChannelDetails.
Return type:	str

sasl_mechanism¶

[Required] Gets the sasl_mechanism of this CreateOSSChannelDetails. The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values.

Returns:	The sasl_mechanism of this CreateOSSChannelDetails.
Return type:	str

security_protocol¶

[Required] Gets the security_protocol of this CreateOSSChannelDetails. The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values.

Returns:	The security_protocol of this CreateOSSChannelDetails.
Return type:	str

session_expiry_duration_in_milliseconds¶

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

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

stream_pool_id¶

[Required] Gets the stream_pool_id of this CreateOSSChannelDetails. The stream pool OCI to use when connecting to the Oracle Streaming Service.

Returns:	The stream_pool_id of this CreateOSSChannelDetails.
Return type:	str

tenancy_name¶

[Required] Gets the tenancy_name of this CreateOSSChannelDetails. The tenancy to use when connecting to the Oracle Streaming Service.

Returns:	The tenancy_name of this CreateOSSChannelDetails.
Return type:	str

type¶

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

Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”

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

user_name¶

[Required] Gets the user_name of this CreateOSSChannelDetails. The user name to use when connecting to the Oracle Streaming Service.

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