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



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
125
126
127
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_characters_character_id_planets_planet_id_pin.rb', line 90

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
  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 `ESI::GetCharactersCharacterIdPlanetsPlanetIdPin`. 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?(:'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']
  end

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

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

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

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

Instance Attribute Details

#contentsObject

contents array



18
19
20
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 18

def contents
  @contents
end

#expiry_timeObject

expiry_time string



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

def expiry_time
  @expiry_time
end

#extractor_detailsObject

Returns the value of attribute extractor_details.



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

def extractor_details
  @extractor_details
end

#factory_detailsObject

Returns the value of attribute factory_details.



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

def factory_details
  @factory_details
end

#install_timeObject

install_time string



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

def install_time
  @install_time
end

#last_cycle_startObject

last_cycle_start string



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

def last_cycle_start
  @last_cycle_start
end

#latitudeObject

latitude number



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

def latitude
  @latitude
end

#longitudeObject

longitude number



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

def longitude
  @longitude
end

#pin_idObject

pin_id integer



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

def pin_id
  @pin_id
end

#schematic_idObject

schematic_id integer



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

def schematic_id
  @schematic_id
end

#type_idObject

type_id integer



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

def type_id
  @type_id
end

Class Method Details

.attribute_mapObject

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



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

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



216
217
218
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 216

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

.openapi_nullableObject

List of attributes with nullable: true



83
84
85
86
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 83

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

.openapi_typesObject

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 66

def self.openapi_types
  {
    :'contents' => :'Object',
    :'expiry_time' => :'Object',
    :'extractor_details' => :'Object',
    :'factory_details' => :'Object',
    :'install_time' => :'Object',
    :'last_cycle_start' => :'Object',
    :'latitude' => :'Object',
    :'longitude' => :'Object',
    :'pin_id' => :'Object',
    :'schematic_id' => :'Object',
    :'type_id' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 185

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

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



246
247
248
249
250
251
252
253
254
255
256
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
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 246

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    ESI.const_get(type).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



315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 315

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 223

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


203
204
205
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 203

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



209
210
211
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 209

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_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 152

def list_invalid_properties
  invalid_properties = Array.new
  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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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



297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 297

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



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

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



175
176
177
178
179
180
181
# File 'lib/ruby-esi/models/get_characters_character_id_planets_planet_id_pin.rb', line 175

def valid?
  return false if @latitude.nil?
  return false if @longitude.nil?
  return false if @pin_id.nil?
  return false if @type_id.nil?
  true
end