Class: MuxRuby::Error

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/models/error.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Error

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/mux_ruby/models/error.rb', line 93

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

  if attributes.key?(:'percentage')
    self.percentage = attributes[:'percentage']
  end

  if attributes.key?(:'notes')
    self.notes = attributes[:'notes']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'last_seen')
    self.last_seen = attributes[:'last_seen']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  end

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  end

  if attributes.key?(:'player_error_code')
    self.player_error_code = attributes[:'player_error_code']
  end
end

Instance Attribute Details

#code ⇒ Object

The error code



40
41
42
 
# File 'lib/mux_ruby/models/error.rb', line 40

def code
  @code
end

#count ⇒ Object

The total number of views that experienced this error.



37
38
39
 
# File 'lib/mux_ruby/models/error.rb', line 37

def count
  @count
end

#description ⇒ Object

Description of the error.



34
35
36
 
# File 'lib/mux_ruby/models/error.rb', line 34

def description
  @description
end

#id ⇒ Object

A unique identifier for this error.



19
20
21
 
# File 'lib/mux_ruby/models/error.rb', line 19

def id
  @id
end

#last_seen ⇒ Object

The last time this error was seen (ISO 8601 timestamp).



31
32
33
 
# File 'lib/mux_ruby/models/error.rb', line 31

def last_seen
  @last_seen
end

#message ⇒ Object

The error message.



28
29
30
 
# File 'lib/mux_ruby/models/error.rb', line 28

def message
  @message
end

#notes ⇒ Object

Notes that are attached to this error.



25
26
27
 
# File 'lib/mux_ruby/models/error.rb', line 25

def notes
  @notes
end

#percentage ⇒ Object

The percentage of views that experienced this error.



22
23
24
 
# File 'lib/mux_ruby/models/error.rb', line 22

def percentage
  @percentage
end

#player_error_code ⇒ Object

The string version of the error code



43
44
45
 
# File 'lib/mux_ruby/models/error.rb', line 43

def player_error_code
  @player_error_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/mux_ruby/models/error.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/mux_ruby/models/error.rb', line 46

def self.attribute_map
  {
    :'id' => :'id',
    :'percentage' => :'percentage',
    :'notes' => :'notes',
    :'message' => :'message',
    :'last_seen' => :'last_seen',
    :'description' => :'description',
    :'count' => :'count',
    :'code' => :'code',
    :'player_error_code' => :'player_error_code'
  }
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



187
188
189
 
# File 'lib/mux_ruby/models/error.rb', line 187

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
85
86
87
88
89
 
# File 'lib/mux_ruby/models/error.rb', line 81

def self.openapi_nullable
  Set.new([
    :'notes',
    :'message',
    :'description',
    :'code',
    :'player_error_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/mux_ruby/models/error.rb', line 66

def self.openapi_types
  {
    :'id' => :'Integer',
    :'percentage' => :'Float',
    :'notes' => :'String',
    :'message' => :'String',
    :'last_seen' => :'String',
    :'description' => :'String',
    :'count' => :'Integer',
    :'code' => :'Integer',
    :'player_error_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      percentage == o.percentage &&
      notes == o.notes &&
      message == o.message &&
      last_seen == o.last_seen &&
      description == o.description &&
      count == o.count &&
      code == o.code &&
      player_error_code == o.player_error_code
end

#_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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/mux_ruby/models/error.rb', line 217

def _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 = MuxRuby.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/mux_ruby/models/error.rb', line 288

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

#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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/mux_ruby/models/error.rb', line 194

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/mux_ruby/models/error.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/mux_ruby/models/error.rb', line 180

def hash
  [id, percentage, notes, message, last_seen, description, count, code, player_error_code].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



145
146
147
148
 
# File 'lib/mux_ruby/models/error.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
 
# File 'lib/mux_ruby/models/error.rb', line 264

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/mux_ruby/models/error.rb', line 270

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

Returns:

  • (String) —

    String presentation of the object



258
259
260
 
# File 'lib/mux_ruby/models/error.rb', line 258

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



152
153
154
 
# File 'lib/mux_ruby/models/error.rb', line 152

def valid?
  true
end