Class: OCI::Oda::Models::UpdateWebChannelDetails

Inherits:
UpdateChannelDetails show all
Defined in:
lib/oci/oda/models/update_web_channel_details.rb

Overview

Properties to update a Web channel.

Constant Summary

Constants inherited from UpdateChannelDetails

OCI::Oda::Models::UpdateChannelDetails::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateChannelDetails

#defined_tags, #description, #freeform_tags, #name, #session_expiry_duration_in_milliseconds, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateChannelDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateWebChannelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 86

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'WEB'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.max_token_expiration_time_in_minutes = attributes[:'maxTokenExpirationTimeInMinutes'] if attributes[:'maxTokenExpirationTimeInMinutes']

  raise 'You cannot provide both :maxTokenExpirationTimeInMinutes and :max_token_expiration_time_in_minutes' if attributes.key?(:'maxTokenExpirationTimeInMinutes') && attributes.key?(:'max_token_expiration_time_in_minutes')

  self.max_token_expiration_time_in_minutes = attributes[:'max_token_expiration_time_in_minutes'] if attributes[:'max_token_expiration_time_in_minutes']

  self.is_client_authentication_enabled = attributes[:'isClientAuthenticationEnabled'] unless attributes[:'isClientAuthenticationEnabled'].nil?

  raise 'You cannot provide both :isClientAuthenticationEnabled and :is_client_authentication_enabled' if attributes.key?(:'isClientAuthenticationEnabled') && attributes.key?(:'is_client_authentication_enabled')

  self.is_client_authentication_enabled = attributes[:'is_client_authentication_enabled'] unless attributes[:'is_client_authentication_enabled'].nil?

  self.allowed_domains = attributes[:'allowedDomains'] if attributes[:'allowedDomains']

  raise 'You cannot provide both :allowedDomains and :allowed_domains' if attributes.key?(:'allowedDomains') && attributes.key?(:'allowed_domains')

  self.allowed_domains = attributes[:'allowed_domains'] if attributes[:'allowed_domains']

  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

#allowed_domains ⇒ String

A comma-delimited whitelist of allowed domains.

The channel will only communicate with the sites from the domains that you add to this list. For example, .corp.example.com, .hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain.

Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains.

Returns:

  • (String) 


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

def allowed_domains
  @allowed_domains
end

#bot_id ⇒ String

The ID of the Skill or Digital Assistant that the Channel is routed to.

Returns:

  • (String) 


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

def bot_id
  @bot_id
end

#is_client_authentication_enabled ⇒ BOOLEAN

Whether client authentication is enabled or not.

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 18

def is_client_authentication_enabled
  @is_client_authentication_enabled
end

#max_token_expiration_time_in_minutes ⇒ Integer

The maximum time until the token expires (in minutes).

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 14

def max_token_expiration_time_in_minutes
  @max_token_expiration_time_in_minutes
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 36

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',
    'max_token_expiration_time_in_minutes': :'maxTokenExpirationTimeInMinutes',
    'is_client_authentication_enabled': :'isClientAuthenticationEnabled',
    'allowed_domains': :'allowedDomains',
    'bot_id': :'botId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 54

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>>',
    'max_token_expiration_time_in_minutes': :'Integer',
    'is_client_authentication_enabled': :'BOOLEAN',
    'allowed_domains': :'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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 128

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    max_token_expiration_time_in_minutes == other.max_token_expiration_time_in_minutes &&
    is_client_authentication_enabled == other.is_client_authentication_enabled &&
    allowed_domains == other.allowed_domains &&
    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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 167

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


147
148
149
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 147

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



156
157
158
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 156

def hash
  [name, description, type, session_expiry_duration_in_milliseconds, freeform_tags, defined_tags, max_token_expiration_time_in_minutes, is_client_authentication_enabled, allowed_domains, 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



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 200

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



194
195
196
 
# File 'lib/oci/oda/models/update_web_channel_details.rb', line 194

def to_s
  to_hash.to_s
end