Class: EsiClient::GetIncursions200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-ruby/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



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'constellation_id')
    self.constellation_id = attributes[:'constellation_id']
  end

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

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

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

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

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

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

  if attributes.has_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/esi-ruby/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/esi-ruby/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/esi-ruby/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/esi-ruby/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/esi-ruby/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/esi-ruby/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/esi-ruby/models/get_incursions_200_ok.rb', line 36

def state
  @state
end

#type ⇒ Object

The type of this incursion



39
40
41
 
# File 'lib/esi-ruby/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/esi-ruby/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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'constellation_id' => :'Integer',
    :'faction_id' => :'Integer',
    :'has_boss' => :'BOOLEAN',
    :'infested_solar_systems' => :'Array<Integer>',
    :'influence' => :'Float',
    :'staging_solar_system_id' => :'Integer',
    :'state' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/esi-ruby/models/get_incursions_200_ok.rb', line 202

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



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
282
283
284
285
286
287
 
# File 'lib/esi-ruby/models/get_incursions_200_ok.rb', line 251

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
    temp_model = EsiClient.const_get(type).new
    temp_model.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



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

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/esi-ruby/models/get_incursions_200_ok.rb', line 230

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/esi-ruby/models/get_incursions_200_ok.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



223
224
225
 
# File 'lib/esi-ruby/models/get_incursions_200_ok.rb', line 223

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 properies with the reasons



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

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

  return 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



297
298
299
 
# File 'lib/esi-ruby/models/get_incursions_200_ok.rb', line 297

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



303
304
305
306
307
308
309
310
311
 
# File 'lib/esi-ruby/models/get_incursions_200_ok.rb', line 303

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



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

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



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/esi-ruby/models/get_incursions_200_ok.rb', line 176

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('String', ["withdrawing", "mobilizing", "established"])
  return false unless state_validator.valid?(@state)
  return false if @type.nil?
  return true
end