Class: OCI::Oda::Models::OsvcChannel

Inherits:
Channel
  • Object
show all
Defined in:
lib/oci/oda/models/osvc_channel.rb

Overview

The configuration for an OSVC channel.

Constant Summary collapse

CHANNEL_SERVICE_ENUM = 
[
  CHANNEL_SERVICE_OSVC = 'OSVC'.freeze,
  CHANNEL_SERVICE_FUSION = 'FUSION'.freeze,
  CHANNEL_SERVICE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Channel

Channel::CATEGORY_ENUM, Channel::LIFECYCLE_STATE_ENUM, Channel::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Channel

#category, #defined_tags, #description, #freeform_tags, #id, #lifecycle_state, #name, #session_expiry_duration_in_milliseconds, #time_created, #time_updated, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Channel

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OsvcChannel

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

  • :name (String) —

    The value to assign to the #name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :category (String) —

    The value to assign to the #category proprety

  • :session_expiry_duration_in_milliseconds (Integer) —

    The value to assign to the #session_expiry_duration_in_milliseconds proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :host (String) —

    The value to assign to the #host property

  • :port (String) —

    The value to assign to the #port property

  • :user_name (String) —

    The value to assign to the #user_name property

  • :total_session_count (Integer) —

    The value to assign to the #total_session_count property

  • :channel_service (String) —

    The value to assign to the #channel_service property

  • :authentication_provider_name (String) —

    The value to assign to the #authentication_provider_name property

  • :bot_id (String) —

    The value to assign to the #bot_id property



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
166
167
168
169
170
171
172
173
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 130

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

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 49

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.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 53

def bot_id
  @bot_id
end

#channel_service ⇒ String

[Required] The type of OSVC service.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 45

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.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 29

def host
  @host
end

#port ⇒ String

[Required] The port.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 33

def port
  @port
end

#total_session_count ⇒ Integer

[Required] The total session count.

Returns:

  • (Integer) 


41
42
43
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 41

def total_session_count
  @total_session_count
end

#user_name ⇒ String

[Required] The user name for the digital-assistant agent.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 37

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 56

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'category': :'category',
    'type': :'type',
    'session_expiry_duration_in_milliseconds': :'sessionExpiryDurationInMilliseconds',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'host': :'host',
    'port': :'port',
    'user_name': :'userName',
    '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.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 82

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'description': :'String',
    'category': :'String',
    'type': :'String',
    'session_expiry_duration_in_milliseconds': :'Integer',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'host': :'String',
    'port': :'String',
    'user_name': :'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.

Parameters:

  • other (Object) —

    the other object to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 195

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    category == other.category &&
    type == other.type &&
    session_expiry_duration_in_milliseconds == other.session_expiry_duration_in_milliseconds &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    host == other.host &&
    port == other.port &&
    user_name == other.user_name &&
    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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 242

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


222
223
224
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 222

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 231

def hash
  [id, name, description, category, type, session_expiry_duration_in_milliseconds, lifecycle_state, time_created, time_updated, freeform_tags, defined_tags, host, port, user_name, total_session_count, channel_service, authentication_provider_name, bot_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 275

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

Returns:

  • (String) —

    String presentation of the object



269
270
271
 
# File 'lib/oci/oda/models/osvc_channel.rb', line 269

def to_s
  to_hash.to_s
end