Class: ESI::GetFwSystems200Ok

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

Overview

200 ok object

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetFwSystems200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
125
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 89

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

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

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

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

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

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

Instance Attribute Details

#contested ⇒ Object

contested string



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

def contested
  @contested
end

#occupier_faction_id ⇒ Object

occupier_faction_id integer



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

def occupier_faction_id
  @occupier_faction_id
end

#owner_faction_id ⇒ Object

owner_faction_id integer



24
25
26
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 24

def owner_faction_id
  @owner_faction_id
end

#solar_system_id ⇒ Object

solar_system_id integer



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

def solar_system_id
  @solar_system_id
end

#victory_points ⇒ Object

victory_points integer



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

def victory_points
  @victory_points
end

#victory_points_threshold ⇒ Object

victory_points_threshold integer



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

def victory_points_threshold
  @victory_points_threshold
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 58

def self.attribute_map
  {
    :'contested' => :'contested',
    :'occupier_faction_id' => :'occupier_faction_id',
    :'owner_faction_id' => :'owner_faction_id',
    :'solar_system_id' => :'solar_system_id',
    :'victory_points' => :'victory_points',
    :'victory_points_threshold' => :'victory_points_threshold'
  }
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



210
211
212
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 210

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 70

def self.openapi_types
  {
    :'contested' => :'Object',
    :'occupier_faction_id' => :'Object',
    :'owner_faction_id' => :'Object',
    :'solar_system_id' => :'Object',
    :'victory_points' => :'Object',
    :'victory_points_threshold' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contested == o.contested &&
      occupier_faction_id == o.occupier_faction_id &&
      owner_faction_id == o.owner_faction_id &&
      solar_system_id == o.solar_system_id &&
      victory_points == o.victory_points &&
      victory_points_threshold == o.victory_points_threshold
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



240
241
242
243
244
245
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
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 240

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



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

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 217

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


197
198
199
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [contested, occupier_faction_id, owner_faction_id, solar_system_id, victory_points, victory_points_threshold].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



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
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 129

def list_invalid_properties
  invalid_properties = Array.new
  if @contested.nil?
    invalid_properties.push('invalid value for "contested", contested cannot be nil.')
  end

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

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

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

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

  if @victory_points_threshold.nil?
    invalid_properties.push('invalid value for "victory_points_threshold", victory_points_threshold 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



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

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 291

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



279
280
281
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 279

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



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/ruby-esi/models/get_fw_systems_200_ok.rb', line 160

def valid?
  return false if @contested.nil?
  contested_validator = EnumAttributeValidator.new('Object', ['captured', 'contested', 'uncontested', 'vulnerable'])
  return false unless contested_validator.valid?(@contested)
  return false if @occupier_faction_id.nil?
  return false if @owner_faction_id.nil?
  return false if @solar_system_id.nil?
  return false if @victory_points.nil?
  return false if @victory_points_threshold.nil?
  true
end