OSSChannel¶

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

Bases: oci.oda.models.channel.Channel

The configuration for an Oracle Streaming Service (OSS) 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
`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
`bootstrap_servers`	[Required] Gets the bootstrap_servers of this OSSChannel.
`category`	[Required] Gets the category of this Channel.
`defined_tags`	Gets the defined_tags of this Channel.
`description`	Gets the description of this Channel.
`event_sink_bot_ids`	Gets the event_sink_bot_ids of this OSSChannel.
`freeform_tags`	Gets the freeform_tags of this Channel.
`id`	[Required] Gets the id of this Channel.
`inbound_message_topic`	[Required] Gets the inbound_message_topic of this OSSChannel.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Channel.
`name`	[Required] Gets the name of this Channel.
`outbound_message_topic`	[Required] Gets the outbound_message_topic of this OSSChannel.
`sasl_mechanism`	[Required] Gets the sasl_mechanism of this OSSChannel.
`security_protocol`	[Required] Gets the security_protocol of this OSSChannel.
`session_expiry_duration_in_milliseconds`	Gets the session_expiry_duration_in_milliseconds of this Channel.
`stream_pool_id`	[Required] Gets the stream_pool_id of this OSSChannel.
`tenancy_name`	[Required] Gets the tenancy_name of this OSSChannel.
`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.
`user_name`	[Required] Gets the user_name of this OSSChannel.

Methods

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

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 OSSChannel 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:

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

bootstrap_servers¶

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

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

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

event_sink_bot_ids¶

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

Returns:	The event_sink_bot_ids of this OSSChannel.
Return type:	list[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

inbound_message_topic¶

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

Returns:	The inbound_message_topic of this OSSChannel.
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

outbound_message_topic¶

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

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

sasl_mechanism¶

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

security_protocol¶

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

stream_pool_id¶

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

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

tenancy_name¶

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

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

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

user_name¶

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

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