Class: Svix::MessageAttemptRecoveredEventData
- Inherits:
-
Object
- Object
- Svix::MessageAttemptRecoveredEventData
- Defined in:
- lib/svix/models/message_attempt_recovered_event_data.rb
Overview
Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it’s failed four times as a "message.attempt.failing" event.
Instance Attribute Summary collapse
-
#app_id ⇒ Object
The app’s ID.
-
#app_uid ⇒ Object
The app’s UID.
-
#endpoint_id ⇒ Object
The ep’s ID.
-
#last_attempt ⇒ Object
Returns the value of attribute last_attempt.
-
#msg_event_id ⇒ Object
The msg’s UID.
-
#msg_id ⇒ Object
The msg’s ID.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ MessageAttemptRecoveredEventData
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ MessageAttemptRecoveredEventData
Initializes the object
75 76 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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 75 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::MessageAttemptRecoveredEventData` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::MessageAttemptRecoveredEventData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'app_id') self.app_id = attributes[:'app_id'] else self.app_id = nil end if attributes.key?(:'app_uid') self.app_uid = attributes[:'app_uid'] end if attributes.key?(:'endpoint_id') self.endpoint_id = attributes[:'endpoint_id'] else self.endpoint_id = nil end if attributes.key?(:'last_attempt') self.last_attempt = attributes[:'last_attempt'] else self.last_attempt = nil end if attributes.key?(:'msg_event_id') self.msg_event_id = attributes[:'msg_event_id'] end if attributes.key?(:'msg_id') self.msg_id = attributes[:'msg_id'] else self.msg_id = nil end end |
Instance Attribute Details
#app_id ⇒ Object
The app’s ID
20 21 22 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 20 def app_id @app_id end |
#app_uid ⇒ Object
The app’s UID
23 24 25 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 23 def app_uid @app_uid end |
#endpoint_id ⇒ Object
The ep’s ID
26 27 28 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 26 def endpoint_id @endpoint_id end |
#last_attempt ⇒ Object
Returns the value of attribute last_attempt.
28 29 30 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 28 def last_attempt @last_attempt end |
#msg_event_id ⇒ Object
The msg’s UID
31 32 33 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 31 def msg_event_id @msg_event_id end |
#msg_id ⇒ Object
The msg’s ID
34 35 36 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 34 def msg_id @msg_id end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 278 def self._deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Svix.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
49 50 51 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 49 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
37 38 39 40 41 42 43 44 45 46 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 37 def self.attribute_map { :'app_id' => :'appId', :'app_uid' => :'appUid', :'endpoint_id' => :'endpointId', :'last_attempt' => :'lastAttempt', :'msg_event_id' => :'msgEventId', :'msg_id' => :'msgId' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 254 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
66 67 68 69 70 71 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 66 def self.openapi_nullable Set.new([ :'app_uid', :'msg_event_id', ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
54 55 56 57 58 59 60 61 62 63 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 54 def self.openapi_types { :'app_id' => :'String', :'app_uid' => :'String', :'endpoint_id' => :'String', :'last_attempt' => :'MessageAttemptFailedData', :'msg_event_id' => :'String', :'msg_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
228 229 230 231 232 233 234 235 236 237 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 228 def ==(o) return true if self.equal?(o) self.class == o.class && app_id == o.app_id && app_uid == o.app_uid && endpoint_id == o.endpoint_id && last_attempt == o.last_attempt && msg_event_id == o.msg_event_id && msg_id == o.msg_id end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 349 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#eql?(o) ⇒ Boolean
241 242 243 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 241 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
247 248 249 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 247 def hash [app_id, app_uid, endpoint_id, last_attempt, msg_event_id, msg_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 123 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @app_id.nil? invalid_properties.push('invalid value for "app_id", app_id cannot be nil.') end if !@app_uid.nil? && @app_uid.to_s.length > 256 invalid_properties.push('invalid value for "app_uid", the character length must be smaller than or equal to 256.') end if !@app_uid.nil? && @app_uid.to_s.length < 1 invalid_properties.push('invalid value for "app_uid", the character length must be great than or equal to 1.') end pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/) if !@app_uid.nil? && @app_uid !~ pattern invalid_properties.push("invalid value for \"app_uid\", must conform to the pattern #{pattern}.") end if @endpoint_id.nil? invalid_properties.push('invalid value for "endpoint_id", endpoint_id cannot be nil.') end if @last_attempt.nil? invalid_properties.push('invalid value for "last_attempt", last_attempt cannot be nil.') end if !@msg_event_id.nil? && @msg_event_id.to_s.length > 256 invalid_properties.push('invalid value for "msg_event_id", the character length must be smaller than or equal to 256.') end if !@msg_event_id.nil? && @msg_event_id.to_s.length < 1 invalid_properties.push('invalid value for "msg_event_id", the character length must be great than or equal to 1.') end pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/) if !@msg_event_id.nil? && @msg_event_id !~ pattern invalid_properties.push("invalid value for \"msg_event_id\", must conform to the pattern #{pattern}.") end if @msg_id.nil? invalid_properties.push('invalid value for "msg_id", msg_id cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
325 326 327 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 325 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 331 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
319 320 321 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 319 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/svix/models/message_attempt_recovered_event_data.rb', line 173 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @app_id.nil? return false if !@app_uid.nil? && @app_uid.to_s.length > 256 return false if !@app_uid.nil? && @app_uid.to_s.length < 1 return false if !@app_uid.nil? && @app_uid !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/) return false if @endpoint_id.nil? return false if @last_attempt.nil? return false if !@msg_event_id.nil? && @msg_event_id.to_s.length > 256 return false if !@msg_event_id.nil? && @msg_event_id.to_s.length < 1 return false if !@msg_event_id.nil? && @msg_event_id !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/) return false if @msg_id.nil? true end |