Class: ESI::GetIncursions200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/models/get_incursions_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 = {}) ⇒ GetIncursions200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

Instance Attribute Details

#constellation_id ⇒ Object

The constellation id in which this incursion takes place



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

def constellation_id
  @constellation_id
end

#faction_id ⇒ Object

The attacking faction’s id



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

def faction_id
  @faction_id
end

#has_boss ⇒ Object

Whether the final encounter has boss or not



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

def has_boss
  @has_boss
end

#infested_solar_systems ⇒ Object

A list of infested solar system ids that are a part of this incursion



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

def infested_solar_systems
  @infested_solar_systems
end

#influence ⇒ Object

Influence of this incursion as a float from 0 to 1



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

def influence
  @influence
end

#staging_solar_system_id ⇒ Object

Staging solar system for this incursion



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

def staging_solar_system_id
  @staging_solar_system_id
end

#state ⇒ Object

The state of this incursion



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

def state
  @state
end

#type ⇒ Object

The type of this incursion



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 64

def self.attribute_map
  {
    :'constellation_id' => :'constellation_id',
    :'faction_id' => :'faction_id',
    :'has_boss' => :'has_boss',
    :'infested_solar_systems' => :'infested_solar_systems',
    :'influence' => :'influence',
    :'staging_solar_system_id' => :'staging_solar_system_id',
    :'state' => :'state',
    :'type' => :'type'
  }
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



242
243
244
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 242

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 92

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

def self.openapi_types
  {
    :'constellation_id' => :'Object',
    :'faction_id' => :'Object',
    :'has_boss' => :'Object',
    :'infested_solar_systems' => :'Object',
    :'influence' => :'Object',
    :'staging_solar_system_id' => :'Object',
    :'state' => :'Object',
    :'type' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      constellation_id == o.constellation_id &&
      faction_id == o.faction_id &&
      has_boss == o.has_boss &&
      infested_solar_systems == o.infested_solar_systems &&
      influence == o.influence &&
      staging_solar_system_id == o.staging_solar_system_id &&
      state == o.state &&
      type == o.type
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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 272

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 341

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 249

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


229
230
231
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 235

def hash
  [constellation_id, faction_id, has_boss, infested_solar_systems, influence, staging_solar_system_id, state, type].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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 149

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

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

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

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

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

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

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

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



317
318
319
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 323

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



311
312
313
 
# File 'lib/ruby-esi/models/get_incursions_200_ok.rb', line 311

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



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

def valid?
  return false if @constellation_id.nil?
  return false if @faction_id.nil?
  return false if @has_boss.nil?
  return false if @infested_solar_systems.nil?
  return false if @influence.nil?
  return false if @staging_solar_system_id.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('Object', ['withdrawing', 'mobilizing', 'established'])
  return false unless state_validator.valid?(@state)
  return false if @type.nil?
  true
end