UpdateOSSChannelDetails

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

Bases: UpdateChannelDetails

Properties to update an Oracle Streaming Service (OSS) channel.

Attributes:

TYPE_ANDROID

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

TYPE_APPEVENT

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

TYPE_APPLICATION

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

TYPE_CORTANA

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

TYPE_FACEBOOK

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

TYPE_IOS

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

TYPE_MSTEAMS

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

TYPE_OSS

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

TYPE_OSVC

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

TYPE_SERVICECLOUD

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

TYPE_SLACK

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

TYPE_TEST

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

TYPE_TWILIO

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

TYPE_WEB

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

TYPE_WEBHOOK

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

auth_token

Gets the auth_token of this UpdateOSSChannelDetails.

bootstrap_servers

Gets the bootstrap_servers of this UpdateOSSChannelDetails.

defined_tags

Gets the defined_tags of this UpdateChannelDetails.

description

Gets the description of this UpdateChannelDetails.

event_sink_bot_ids

Gets the event_sink_bot_ids of this UpdateOSSChannelDetails.

freeform_tags

Gets the freeform_tags of this UpdateChannelDetails.

inbound_message_topic

Gets the inbound_message_topic of this UpdateOSSChannelDetails.

name

Gets the name of this UpdateChannelDetails.

outbound_message_topic

Gets the outbound_message_topic of this UpdateOSSChannelDetails.

sasl_mechanism

Gets the sasl_mechanism of this UpdateOSSChannelDetails.

security_protocol

Gets the security_protocol of this UpdateOSSChannelDetails.

session_expiry_duration_in_milliseconds

Gets the session_expiry_duration_in_milliseconds of this UpdateChannelDetails.

stream_pool_id

Gets the stream_pool_id of this UpdateOSSChannelDetails.

tenancy_name

Gets the tenancy_name of this UpdateOSSChannelDetails.

type

[Required] Gets the type of this UpdateChannelDetails.

user_name

Gets the user_name of this UpdateOSSChannelDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdateOSSChannelDetails 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'

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

TYPE_APPEVENT = 'APPEVENT'

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

TYPE_APPLICATION = 'APPLICATION'

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

TYPE_CORTANA = 'CORTANA'

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

TYPE_FACEBOOK = 'FACEBOOK'

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

TYPE_IOS = 'IOS'

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

TYPE_MSTEAMS = 'MSTEAMS'

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

TYPE_OSS = 'OSS'

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

TYPE_OSVC = 'OSVC'

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

TYPE_SERVICECLOUD = 'SERVICECLOUD'

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

TYPE_SLACK = 'SLACK'

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

TYPE_TEST = 'TEST'

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

TYPE_TWILIO = 'TWILIO'

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

TYPE_WEB = 'WEB'

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

TYPE_WEBHOOK = 'WEBHOOK'

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

__init__(**kwargs)

Initializes a new UpdateOSSChannelDetails 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 UpdateOSSChannelDetails.

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

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

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateOSSChannelDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateOSSChannelDetails.

  • event_sink_bot_ids (list[str]) – The value to assign to the event_sink_bot_ids property of this UpdateOSSChannelDetails.

  • inbound_message_topic (str) – The value to assign to the inbound_message_topic property of this UpdateOSSChannelDetails.

  • outbound_message_topic (str) – The value to assign to the outbound_message_topic property of this UpdateOSSChannelDetails.

  • bootstrap_servers (str) – The value to assign to the bootstrap_servers property of this UpdateOSSChannelDetails.

  • security_protocol (str) – The value to assign to the security_protocol property of this UpdateOSSChannelDetails.

  • sasl_mechanism (str) – The value to assign to the sasl_mechanism property of this UpdateOSSChannelDetails.

  • tenancy_name (str) – The value to assign to the tenancy_name property of this UpdateOSSChannelDetails.

  • user_name (str) – The value to assign to the user_name property of this UpdateOSSChannelDetails.

  • stream_pool_id (str) – The value to assign to the stream_pool_id property of this UpdateOSSChannelDetails.

  • auth_token (str) – The value to assign to the auth_token property of this UpdateOSSChannelDetails.

property auth_token

Gets the auth_token of this UpdateOSSChannelDetails. The authentication token to use when connecting to the Oracle Streaming Service.

Returns

The auth_token of this UpdateOSSChannelDetails.

Return type

str

property bootstrap_servers

Gets the bootstrap_servers of this UpdateOSSChannelDetails. The Oracle Streaming Service bootstrap servers.

Returns

The bootstrap_servers of this UpdateOSSChannelDetails.

Return type

str

property defined_tags

Gets the defined_tags of this UpdateChannelDetails. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this UpdateChannelDetails.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this UpdateChannelDetails.

Return type

str

property event_sink_bot_ids

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

Returns

The event_sink_bot_ids of this UpdateOSSChannelDetails.

Return type

list[str]

property freeform_tags

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

Returns

The freeform_tags of this UpdateChannelDetails.

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 inbound_message_topic

Gets the inbound_message_topic of this UpdateOSSChannelDetails. The topic inbound messages are received on.

Returns

The inbound_message_topic of this UpdateOSSChannelDetails.

Return type

str

property name

Gets the name of this UpdateChannelDetails. 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 UpdateChannelDetails.

Return type

str

property outbound_message_topic

Gets the outbound_message_topic of this UpdateOSSChannelDetails. The topic outbound messages are sent on.

Returns

The outbound_message_topic of this UpdateOSSChannelDetails.

Return type

str

property sasl_mechanism

Gets the sasl_mechanism of this UpdateOSSChannelDetails. 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 UpdateOSSChannelDetails.

Return type

str

property security_protocol

Gets the security_protocol of this UpdateOSSChannelDetails. 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 UpdateOSSChannelDetails.

Return type

str

property session_expiry_duration_in_milliseconds

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

Returns

The session_expiry_duration_in_milliseconds of this UpdateChannelDetails.

Return type

int

property stream_pool_id

Gets the stream_pool_id of this UpdateOSSChannelDetails. The stream pool OCI to use when connecting to the Oracle Streaming Service.

Returns

The stream_pool_id of this UpdateOSSChannelDetails.

Return type

str

property tenancy_name

Gets the tenancy_name of this UpdateOSSChannelDetails. The tenancy to use when connecting to the Oracle Streaming Service.

Returns

The tenancy_name of this UpdateOSSChannelDetails.

Return type

str

property type

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

Return type

str

property user_name

Gets the user_name of this UpdateOSSChannelDetails. The user name to use when connecting to the Oracle Streaming Service.

Returns

The user_name of this UpdateOSSChannelDetails.

Return type

str