Class: ESI::GetKillmailsKillmailIdKillmailHashItem

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb

Overview

item object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetKillmailsKillmailIdKillmailHashItem

Initializes the object



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
120
121
122
123
124
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ESI::GetKillmailsKillmailIdKillmailHashItem` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ESI::GetKillmailsKillmailIdKillmailHashItem`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'items')
    if (value = attributes[:'items']).is_a?(Array)
      self.items = value
    end
  end

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

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

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

Instance Attribute Details

#flag ⇒ Object

Flag for the location of the item



20
21
22
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 20

def flag
  @flag
end

#item_type_id ⇒ Object

item_type_id integer



23
24
25
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 23

def item_type_id
  @item_type_id
end

#items ⇒ Object

items array



26
27
28
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 26

def items
  @items
end

#quantity_destroyed ⇒ Object

How many of the item were destroyed if any



29
30
31
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 29

def quantity_destroyed
  @quantity_destroyed
end

#quantity_dropped ⇒ Object

How many of the item were dropped if any



32
33
34
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 32

def quantity_dropped
  @quantity_dropped
end

#singleton ⇒ Object

singleton integer



35
36
37
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 35

def singleton
  @singleton
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



257
258
259
260
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
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 257

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 = ESI.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



50
51
52
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 50

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 55

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 38

def self.attribute_map
  {
    :'flag' => :'flag',
    :'item_type_id' => :'item_type_id',
    :'items' => :'items',
    :'quantity_destroyed' => :'quantity_destroyed',
    :'quantity_dropped' => :'quantity_dropped',
    :'singleton' => :'singleton'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 233

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



72
73
74
75
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 72

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 60

def self.openapi_types
  {
    :'flag' => :'Integer',
    :'item_type_id' => :'Integer',
    :'items' => :'Array<GetKillmailsKillmailIdKillmailHashItemsItem>',
    :'quantity_destroyed' => :'Integer',
    :'quantity_dropped' => :'Integer',
    :'singleton' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      flag == o.flag &&
      item_type_id == o.item_type_id &&
      items == o.items &&
      quantity_destroyed == o.quantity_destroyed &&
      quantity_dropped == o.quantity_dropped &&
      singleton == o.singleton
end

#_to_hash(value) ⇒ Hash

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 328

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

See Also:

  • `==` method


220
221
222
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



226
227
228
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 226

def hash
  [flag, item_type_id, items, quantity_destroyed, quantity_dropped, singleton].hash
end

#list_invalid_properties ⇒ Object

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 128

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @flag.nil?
    invalid_properties.push('invalid value for "flag", flag cannot be nil.')
  end

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

  if !@items.nil? && @items.length > 10000
    invalid_properties.push('invalid value for "items", number of items must be less than or equal to 10000.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



304
305
306
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 304

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 310

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



298
299
300
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 298

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



152
153
154
155
156
157
158
159
 
# File 'lib/ruby-esi/models/get_killmails_killmail_id_killmail_hash_item.rb', line 152

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @flag.nil?
  return false if @item_type_id.nil?
  return false if !@items.nil? && @items.length > 10000
  return false if @singleton.nil?
  true
end