Class: OCI::Oda::Models::CortanaChannel

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

Overview

The configuration for a Cortana channel.

Constant Summary

Constants inherited from Channel

OCI::Oda::Models::Channel::CATEGORY_ENUM, OCI::Oda::Models::Channel::LIFECYCLE_STATE_ENUM, OCI::Oda::Models::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 = {}) ⇒ CortanaChannel

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

  • :msa_app_id (String) —

    The value to assign to the #msa_app_id property

  • :bot_id (String) —

    The value to assign to the #bot_id property

  • :webhook_url (String) —

    The value to assign to the #webhook_url property



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
 
# File 'lib/oci/oda/models/cortana_channel.rb', line 89

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

  attributes['type'] = 'CORTANA'

  super(attributes)

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

  self.msa_app_id = attributes[:'msaAppId'] if attributes[:'msaAppId']

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

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

  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']

  self.webhook_url = attributes[:'webhookUrl'] if attributes[:'webhookUrl']

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

  self.webhook_url = attributes[:'webhook_url'] if attributes[:'webhook_url']
end

Instance Attribute Details

#bot_id ⇒ String

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

Returns:

  • (String) 


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

def bot_id
  @bot_id
end

#msa_app_id ⇒ String

[Required] The Microsoft App ID that you obtained when you created your bot registration in Azure.

Returns:

  • (String) 


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

def msa_app_id
  @msa_app_id
end

#webhook_url ⇒ String

[Required] The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/oda/models/cortana_channel.rb', line 24

def webhook_url
  @webhook_url
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/oda/models/cortana_channel.rb', line 27

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',
    'msa_app_id': :'msaAppId',
    'bot_id': :'botId',
    'webhook_url': :'webhookUrl'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/oda/models/cortana_channel.rb', line 49

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>>',
    'msa_app_id': :'String',
    'bot_id': :'String',
    'webhook_url': :'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



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

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 &&
    msa_app_id == other.msa_app_id &&
    bot_id == other.bot_id &&
    webhook_url == other.webhook_url
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



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

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


148
149
150
 
# File 'lib/oci/oda/models/cortana_channel.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/oci/oda/models/cortana_channel.rb', line 157

def hash
  [id, name, description, category, type, session_expiry_duration_in_milliseconds, lifecycle_state, time_created, time_updated, freeform_tags, defined_tags, msa_app_id, bot_id, webhook_url].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



195
196
197
 
# File 'lib/oci/oda/models/cortana_channel.rb', line 195

def to_s
  to_hash.to_s
end