Class: Svix::EndpointDisabledEventData

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/models/endpoint_disabled_event_data.rb

Overview

Sent when an endpoint has been automatically disabled after continuous failures.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndpointDisabledEventData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
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
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 70

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::EndpointDisabledEventData` 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::EndpointDisabledEventData`. 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?(:'endpoint_uid')
    self.endpoint_uid = attributes[:'endpoint_uid']
  end

  if attributes.key?(:'fail_since')
    self.fail_since = attributes[:'fail_since']
  else
    self.fail_since = nil
  end
end

Instance Attribute Details

#app_idObject

The app’s ID



20
21
22
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 20

def app_id
  @app_id
end

#app_uidObject

The app’s UID



23
24
25
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 23

def app_uid
  @app_uid
end

#endpoint_idObject

The ep’s ID



26
27
28
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 26

def endpoint_id
  @endpoint_id
end

#endpoint_uidObject

The ep’s UID



29
30
31
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 29

def endpoint_uid
  @endpoint_uid
end

#fail_sinceObject

Returns the value of attribute fail_since.



31
32
33
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 31

def fail_since
  @fail_since
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 261

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_attributesObject

Returns all the JSON keys this model knows about



45
46
47
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



34
35
36
37
38
39
40
41
42
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 34

def self.attribute_map
  {
    :'app_id' => :'appId',
    :'app_uid' => :'appUid',
    :'endpoint_id' => :'endpointId',
    :'endpoint_uid' => :'endpointUid',
    :'fail_since' => :'failSince'
  }
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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 237

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_nullableObject

List of attributes with nullable: true



61
62
63
64
65
66
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 61

def self.openapi_nullable
  Set.new([
    :'app_uid',
    :'endpoint_uid',
  ])
end

.openapi_typesObject

Attribute type mapping.



50
51
52
53
54
55
56
57
58
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 50

def self.openapi_types
  {
    :'app_id' => :'String',
    :'app_uid' => :'String',
    :'endpoint_id' => :'String',
    :'endpoint_uid' => :'String',
    :'fail_since' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



212
213
214
215
216
217
218
219
220
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 212

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 &&
      endpoint_uid == o.endpoint_uid &&
      fail_since == o.fail_since
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 332

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


224
225
226
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 224

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



230
231
232
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 230

def hash
  [app_id, app_uid, endpoint_id, endpoint_uid, fail_since].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
152
153
154
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 112

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 !@endpoint_uid.nil? && @endpoint_uid.to_s.length > 256
    invalid_properties.push('invalid value for "endpoint_uid", the character length must be smaller than or equal to 256.')
  end

  if !@endpoint_uid.nil? && @endpoint_uid.to_s.length < 1
    invalid_properties.push('invalid value for "endpoint_uid", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if !@endpoint_uid.nil? && @endpoint_uid !~ pattern
    invalid_properties.push("invalid value for \"endpoint_uid\", must conform to the pattern #{pattern}.")
  end

  if @fail_since.nil?
    invalid_properties.push('invalid value for "fail_since", fail_since cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



308
309
310
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 308

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 314

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



302
303
304
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 302

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/svix/models/endpoint_disabled_event_data.rb', line 158

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 !@endpoint_uid.nil? && @endpoint_uid.to_s.length > 256
  return false if !@endpoint_uid.nil? && @endpoint_uid.to_s.length < 1
  return false if !@endpoint_uid.nil? && @endpoint_uid !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  return false if @fail_since.nil?
  true
end