Class: OCI::Oda::Models::CreateWebhookChannelDetails

Inherits:
CreateChannelDetails show all
Defined in:
lib/oci/oda/models/create_webhook_channel_details.rb

Overview

Properties required to create a Webhook channel.

Constant Summary collapse

PAYLOAD_VERSION_ENUM = 
[
  PAYLOAD_VERSION_1_0 = '1.0'.freeze,
  PAYLOAD_VERSION_1_1 = '1.1'.freeze
].freeze

Constants inherited from CreateChannelDetails

OCI::Oda::Models::CreateChannelDetails::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateChannelDetails

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateChannelDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateWebhookChannelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :session_expiry_duration_in_milliseconds (Integer) —

    The value to assign to the #session_expiry_duration_in_milliseconds 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

  • :outbound_url (String) —

    The value to assign to the #outbound_url property

  • :payload_version (String) —

    The value to assign to the #payload_version property

  • :bot_id (String) —

    The value to assign to the #bot_id property



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

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

  attributes['type'] = 'WEBHOOK'

  super(attributes)

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

  self.outbound_url = attributes[:'outboundUrl'] if attributes[:'outboundUrl']

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

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

  self.payload_version = attributes[:'payloadVersion'] if attributes[:'payloadVersion']

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

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

  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

#bot_id ⇒ String

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

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 27

def bot_id
  @bot_id
end

#outbound_url ⇒ String

[Required] The URL to send responses to.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 19

def outbound_url
  @outbound_url
end

#payload_version ⇒ String

[Required] The version for payloads.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 23

def payload_version
  @payload_version
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 30

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',
    'outbound_url': :'outboundUrl',
    'payload_version': :'payloadVersion',
    'bot_id': :'botId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 47

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>>',
    'outbound_url': :'String',
    'payload_version': :'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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 121

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 &&
    outbound_url == other.outbound_url &&
    payload_version == other.payload_version &&
    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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 159

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


139
140
141
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 139

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [name, description, type, session_expiry_duration_in_milliseconds, freeform_tags, defined_tags, outbound_url, payload_version, 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



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 192

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



186
187
188
 
# File 'lib/oci/oda/models/create_webhook_channel_details.rb', line 186

def to_s
  to_hash.to_s
end