Class: OCI::Oda::Models::CreateWebhookChannelResult
- Inherits:
-
CreateChannelResult
- Object
- CreateChannelResult
- OCI::Oda::Models::CreateWebhookChannelResult
- Defined in:
- lib/oci/oda/models/create_webhook_channel_result.rb
Overview
The configuration for a Webhook channel.
Constant Summary collapse
- PAYLOAD_VERSION_ENUM =
[ PAYLOAD_VERSION_1_0 = '1.0'.freeze, PAYLOAD_VERSION_1_1 = '1.1'.freeze, PAYLOAD_VERSION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Constants inherited from CreateChannelResult
OCI::Oda::Models::CreateChannelResult::CATEGORY_ENUM, OCI::Oda::Models::CreateChannelResult::LIFECYCLE_STATE_ENUM, OCI::Oda::Models::CreateChannelResult::TYPE_ENUM
Instance Attribute Summary collapse
-
#bot_id ⇒ String
The ID of the Skill or Digital Assistant that the Channel is routed to.
-
#outbound_url ⇒ String
[Required] The URL to send responses to.
-
#payload_version ⇒ String
[Required] The version for payloads.
-
#secret_key ⇒ String
[Required] The secret key used to verify the authenticity of received messages.
-
#webhook_url ⇒ String
[Required] The URL to use to send messages to this channel.
Attributes inherited from CreateChannelResult
#category, #defined_tags, #description, #freeform_tags, #id, #lifecycle_state, #name, #session_expiry_duration_in_milliseconds, #time_created, #time_updated, #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 = {}) ⇒ CreateWebhookChannelResult
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 CreateChannelResult
Constructor Details
#initialize(attributes = {}) ⇒ CreateWebhookChannelResult
Initializes the object
112 113 114 115 116 117 118 119 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 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 112 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.secret_key = attributes[:'secretKey'] if attributes[:'secretKey'] raise 'You cannot provide both :secretKey and :secret_key' if attributes.key?(:'secretKey') && attributes.key?(:'secret_key') self.secret_key = attributes[:'secret_key'] if attributes[:'secret_key'] 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'] 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.
35 36 37 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 35 def bot_id @bot_id end |
#outbound_url ⇒ String
[Required] The URL to send responses to.
27 28 29 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 27 def outbound_url @outbound_url end |
#payload_version ⇒ String
[Required] The version for payloads.
31 32 33 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 31 def payload_version @payload_version end |
#secret_key ⇒ String
[Required] The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key.
23 24 25 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 23 def secret_key @secret_key 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.
41 42 43 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 41 def webhook_url @webhook_url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 44 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', 'secret_key': :'secretKey', 'outbound_url': :'outboundUrl', 'payload_version': :'payloadVersion', 'bot_id': :'botId', 'webhook_url': :'webhookUrl' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 68 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>>', 'secret_key': :'String', 'outbound_url': :'String', 'payload_version': :'String', 'bot_id': :'String', 'webhook_url': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 173 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 && == other. && == other. && secret_key == other.secret_key && outbound_url == other.outbound_url && payload_version == other.payload_version && bot_id == other.bot_id && webhook_url == other.webhook_url end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 218 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
198 199 200 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 198 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
207 208 209 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 207 def hash [id, name, description, category, type, session_expiry_duration_in_milliseconds, lifecycle_state, time_created, time_updated, , , secret_key, outbound_url, payload_version, bot_id, webhook_url].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
251 252 253 254 255 256 257 258 259 260 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 251 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
245 246 247 |
# File 'lib/oci/oda/models/create_webhook_channel_result.rb', line 245 def to_s to_hash.to_s end |