Class: OCI::Oda::Models::CreateOsvcChannelDetails
- Inherits:
-
CreateChannelDetails
- Object
- CreateChannelDetails
- OCI::Oda::Models::CreateOsvcChannelDetails
- Defined in:
- lib/oci/oda/models/create_osvc_channel_details.rb
Overview
Properties required to create an OSVC channel.
Constant Summary collapse
- CHANNEL_SERVICE_ENUM =
[ CHANNEL_SERVICE_OSVC = 'OSVC'.freeze, CHANNEL_SERVICE_FUSION = 'FUSION'.freeze ].freeze
Constants inherited from CreateChannelDetails
OCI::Oda::Models::CreateChannelDetails::TYPE_ENUM
Instance Attribute Summary collapse
-
#authentication_provider_name ⇒ String
[Required] The name of the Authentication Provider to use to authenticate the user.
-
#bot_id ⇒ String
The ID of the Skill or Digital Assistant that the Channel is routed to.
-
#channel_service ⇒ String
The type of OSVC service.
-
#host ⇒ String
[Required] The host.
-
#password ⇒ String
[Required] The password for the digital-assistant agent.
-
#port ⇒ String
[Required] The port.
-
#total_session_count ⇒ Integer
[Required] The total session count.
-
#user_name ⇒ String
[Required] The user name for the digital-assistant agent.
Attributes inherited from CreateChannelDetails
#defined_tags, #description, #freeform_tags, #name, #session_expiry_duration_in_milliseconds, #type
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateOsvcChannelDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Methods inherited from CreateChannelDetails
Constructor Details
#initialize(attributes = {}) ⇒ CreateOsvcChannelDetails
Initializes the object
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 120 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['type'] = 'OSVC' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.host = attributes[:'host'] if attributes[:'host'] self.port = attributes[:'port'] if attributes[:'port'] self.user_name = attributes[:'userName'] if attributes[:'userName'] raise 'You cannot provide both :userName and :user_name' if attributes.key?(:'userName') && attributes.key?(:'user_name') self.user_name = attributes[:'user_name'] if attributes[:'user_name'] self.password = attributes[:'password'] if attributes[:'password'] self.total_session_count = attributes[:'totalSessionCount'] if attributes[:'totalSessionCount'] raise 'You cannot provide both :totalSessionCount and :total_session_count' if attributes.key?(:'totalSessionCount') && attributes.key?(:'total_session_count') self.total_session_count = attributes[:'total_session_count'] if attributes[:'total_session_count'] self.channel_service = attributes[:'channelService'] if attributes[:'channelService'] raise 'You cannot provide both :channelService and :channel_service' if attributes.key?(:'channelService') && attributes.key?(:'channel_service') self.channel_service = attributes[:'channel_service'] if attributes[:'channel_service'] self.authentication_provider_name = attributes[:'authenticationProviderName'] if attributes[:'authenticationProviderName'] raise 'You cannot provide both :authenticationProviderName and :authentication_provider_name' if attributes.key?(:'authenticationProviderName') && attributes.key?(:'authentication_provider_name') self.authentication_provider_name = attributes[:'authentication_provider_name'] if attributes[:'authentication_provider_name'] self.bot_id = attributes[:'botId'] if attributes[:'botId'] raise 'You cannot provide both :botId and :bot_id' if attributes.key?(:'botId') && attributes.key?(:'bot_id') self.bot_id = attributes[:'bot_id'] if attributes[:'bot_id'] end |
Instance Attribute Details
#authentication_provider_name ⇒ String
[Required] The name of the Authentication Provider to use to authenticate the user.
51 52 53 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 51 def authentication_provider_name @authentication_provider_name end |
#bot_id ⇒ String
The ID of the Skill or Digital Assistant that the Channel is routed to.
55 56 57 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 55 def bot_id @bot_id end |
#channel_service ⇒ String
The type of OSVC service.
47 48 49 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 47 def channel_service @channel_service end |
#host ⇒ String
[Required] 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 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.
27 28 29 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 27 def host @host end |
#password ⇒ String
[Required] The password for the digital-assistant agent.
39 40 41 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 39 def password @password end |
#port ⇒ String
[Required] The port.
31 32 33 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 31 def port @port end |
#total_session_count ⇒ Integer
[Required] The total session count.
43 44 45 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 43 def total_session_count @total_session_count end |
#user_name ⇒ String
[Required] The user name for the digital-assistant agent.
35 36 37 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 35 def user_name @user_name end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 58 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'description': :'description', 'type': :'type', 'session_expiry_duration_in_milliseconds': :'sessionExpiryDurationInMilliseconds', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'host': :'host', 'port': :'port', 'user_name': :'userName', 'password': :'password', 'total_session_count': :'totalSessionCount', 'channel_service': :'channelService', 'authentication_provider_name': :'authenticationProviderName', 'bot_id': :'botId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 80 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'description': :'String', 'type': :'String', 'session_expiry_duration_in_milliseconds': :'Integer', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'host': :'String', 'port': :'String', 'user_name': :'String', 'password': :'String', 'total_session_count': :'Integer', 'channel_service': :'String', 'authentication_provider_name': :'String', 'bot_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 182 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && description == other.description && type == other.type && session_expiry_duration_in_milliseconds == other.session_expiry_duration_in_milliseconds && == other. && == other. && host == other.host && port == other.port && user_name == other.user_name && password == other.password && total_session_count == other.total_session_count && channel_service == other.channel_service && authentication_provider_name == other.authentication_provider_name && bot_id == other.bot_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 225 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
205 206 207 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 205 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
214 215 216 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 214 def hash [name, description, type, session_expiry_duration_in_milliseconds, , , host, port, user_name, password, total_session_count, channel_service, authentication_provider_name, bot_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
258 259 260 261 262 263 264 265 266 267 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 258 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
252 253 254 |
# File 'lib/oci/oda/models/create_osvc_channel_details.rb', line 252 def to_s to_hash.to_s end |