Class: ESI::GetCharactersCharacterIdPlanetsPlanetIdPin

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

Overview

pin object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCharactersCharacterIdPlanetsPlanetIdPin

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 102

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#contents ⇒ Object

contents array



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

def contents
  @contents
end

#expiry_time ⇒ Object

expiry_time string



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

def expiry_time
  @expiry_time
end

#extractor_details ⇒ Object

Returns the value of attribute extractor_details.



25
26
27
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 25

def extractor_details
  @extractor_details
end

#factory_details ⇒ Object

Returns the value of attribute factory_details.



27
28
29
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 27

def factory_details
  @factory_details
end

#install_time ⇒ Object

install_time string



30
31
32
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 30

def install_time
  @install_time
end

#last_cycle_start ⇒ Object

last_cycle_start string



33
34
35
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 33

def last_cycle_start
  @last_cycle_start
end

#latitude ⇒ Object

latitude number



36
37
38
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 36

def latitude
  @latitude
end

#longitude ⇒ Object

longitude number



39
40
41
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 39

def longitude
  @longitude
end

#pin_id ⇒ Object

pin_id integer



42
43
44
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 42

def pin_id
  @pin_id
end

#schematic_id ⇒ Object

schematic_id integer



45
46
47
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 45

def schematic_id
  @schematic_id
end

#type_id ⇒ Object

type_id integer



48
49
50
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 48

def type_id
  @type_id
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 322

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



68
69
70
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 51

def self.attribute_map
  {
    :'contents' => :'contents',
    :'expiry_time' => :'expiry_time',
    :'extractor_details' => :'extractor_details',
    :'factory_details' => :'factory_details',
    :'install_time' => :'install_time',
    :'last_cycle_start' => :'last_cycle_start',
    :'latitude' => :'latitude',
    :'longitude' => :'longitude',
    :'pin_id' => :'pin_id',
    :'schematic_id' => :'schematic_id',
    :'type_id' => :'type_id'
  }
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 298

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



95
96
97
98
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 95

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 78

def self.openapi_types
  {
    :'contents' => :'Array<GetCharactersCharacterIdPlanetsPlanetIdContent>',
    :'expiry_time' => :'Time',
    :'extractor_details' => :'GetCharactersCharacterIdPlanetsPlanetIdExtractorDetails',
    :'factory_details' => :'GetCharactersCharacterIdPlanetsPlanetIdFactoryDetails',
    :'install_time' => :'Time',
    :'last_cycle_start' => :'Time',
    :'latitude' => :'Float',
    :'longitude' => :'Float',
    :'pin_id' => :'Integer',
    :'schematic_id' => :'Integer',
    :'type_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contents == o.contents &&
      expiry_time == o.expiry_time &&
      extractor_details == o.extractor_details &&
      factory_details == o.factory_details &&
      install_time == o.install_time &&
      last_cycle_start == o.last_cycle_start &&
      latitude == o.latitude &&
      longitude == o.longitude &&
      pin_id == o.pin_id &&
      schematic_id == o.schematic_id &&
      type_id == o.type_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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 393

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


285
286
287
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 291

def hash
  [contents, expiry_time, extractor_details, factory_details, install_time, last_cycle_start, latitude, longitude, pin_id, schematic_id, type_id].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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 173

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@contents.nil? && @contents.length > 90
    invalid_properties.push('invalid value for "contents", number of items must be less than or equal to 90.')
  end

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

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

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

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

  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



369
370
371
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 369

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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 375

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



363
364
365
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 363

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



201
202
203
204
205
206
207
208
209
 
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 201

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@contents.nil? && @contents.length > 90
  return false if @latitude.nil?
  return false if @longitude.nil?
  return false if @pin_id.nil?
  return false if @type_id.nil?
  true
end