Class: ESI::GetCorporationsCorporationIdStructures200Ok

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
170
171
172
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
198
199
200
201
202
203
204
205
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 134

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?(:'corporation_id')
    self.corporation_id = attributes[:'corporation_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#corporation_id ⇒ Object

ID of the corporation that owns the structure



19
20
21
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 19

def corporation_id
  @corporation_id
end

#fuel_expires ⇒ Object

Date on which the structure will run out of fuel



22
23
24
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 22

def fuel_expires
  @fuel_expires
end

#next_reinforce_apply ⇒ Object

The date and time when the structure’s newly requested reinforcement times (e.g. next_reinforce_hour and next_reinforce_day) will take effect



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

def next_reinforce_apply
  @next_reinforce_apply
end

#next_reinforce_hour ⇒ Object

The requested change to reinforce_hour that will take effect at the time shown by next_reinforce_apply



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

def next_reinforce_hour
  @next_reinforce_hour
end

#next_reinforce_weekday ⇒ Object

The requested change to reinforce_weekday that will take effect at the time shown by next_reinforce_apply



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

def next_reinforce_weekday
  @next_reinforce_weekday
end

#profile_id ⇒ Object

The id of the ACL profile for this citadel



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

def profile_id
  @profile_id
end

#reinforce_hour ⇒ Object

The hour of day that determines the four hour window when the structure will randomly exit its reinforcement periods and become vulnerable to attack against its armor and/or hull. The structure will become vulnerable at a random time that is +/- 2 hours centered on the value of this property



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

def reinforce_hour
  @reinforce_hour
end

#reinforce_weekday ⇒ Object

The day of the week when the structure exits its final reinforcement period and becomes vulnerable to attack against its hull. Monday is 0 and Sunday is 6



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

def reinforce_weekday
  @reinforce_weekday
end

#services ⇒ Object

Contains a list of service upgrades, and their state



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

def services
  @services
end

#state ⇒ Object

state string



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

def state
  @state
end

#state_timer_end ⇒ Object

Date at which the structure will move to it’s next state



49
50
51
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 49

def state_timer_end
  @state_timer_end
end

#state_timer_start ⇒ Object

Date at which the structure entered it’s current state



52
53
54
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 52

def state_timer_start
  @state_timer_start
end

#structure_id ⇒ Object

The Item ID of the structure



55
56
57
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 55

def structure_id
  @structure_id
end

#system_id ⇒ Object

The solar system the structure is in



58
59
60
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 58

def system_id
  @system_id
end

#type_id ⇒ Object

The type id of the structure



61
62
63
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 61

def type_id
  @type_id
end

#unanchors_at ⇒ Object

Date at which the structure will unanchor



64
65
66
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 64

def unanchors_at
  @unanchors_at
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 89

def self.attribute_map
  {
    :'corporation_id' => :'corporation_id',
    :'fuel_expires' => :'fuel_expires',
    :'next_reinforce_apply' => :'next_reinforce_apply',
    :'next_reinforce_hour' => :'next_reinforce_hour',
    :'next_reinforce_weekday' => :'next_reinforce_weekday',
    :'profile_id' => :'profile_id',
    :'reinforce_hour' => :'reinforce_hour',
    :'reinforce_weekday' => :'reinforce_weekday',
    :'services' => :'services',
    :'state' => :'state',
    :'state_timer_end' => :'state_timer_end',
    :'state_timer_start' => :'state_timer_start',
    :'structure_id' => :'structure_id',
    :'system_id' => :'system_id',
    :'type_id' => :'type_id',
    :'unanchors_at' => :'unanchors_at'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 111

def self.swagger_types
  {
    :'corporation_id' => :'Integer',
    :'fuel_expires' => :'DateTime',
    :'next_reinforce_apply' => :'DateTime',
    :'next_reinforce_hour' => :'Integer',
    :'next_reinforce_weekday' => :'Integer',
    :'profile_id' => :'Integer',
    :'reinforce_hour' => :'Integer',
    :'reinforce_weekday' => :'Integer',
    :'services' => :'Array<GetCorporationsCorporationIdStructuresService>',
    :'state' => :'String',
    :'state_timer_end' => :'DateTime',
    :'state_timer_start' => :'DateTime',
    :'structure_id' => :'Integer',
    :'system_id' => :'Integer',
    :'type_id' => :'Integer',
    :'unanchors_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 369

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      corporation_id == o.corporation_id &&
      fuel_expires == o.fuel_expires &&
      next_reinforce_apply == o.next_reinforce_apply &&
      next_reinforce_hour == o.next_reinforce_hour &&
      next_reinforce_weekday == o.next_reinforce_weekday &&
      profile_id == o.profile_id &&
      reinforce_hour == o.reinforce_hour &&
      reinforce_weekday == o.reinforce_weekday &&
      services == o.services &&
      state == o.state &&
      state_timer_end == o.state_timer_end &&
      state_timer_start == o.state_timer_start &&
      structure_id == o.structure_id &&
      system_id == o.system_id &&
      type_id == o.type_id &&
      unanchors_at == o.unanchors_at
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



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 426

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 = ESI.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



492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 492

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



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 405

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


392
393
394
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 392

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



398
399
400
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 398

def hash
  [corporation_id, fuel_expires, next_reinforce_apply, next_reinforce_hour, next_reinforce_weekday, profile_id, reinforce_hour, reinforce_weekday, services, state, state_timer_end, state_timer_start, structure_id, system_id, type_id, unanchors_at].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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
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
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 209

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

  if !@next_reinforce_hour.nil? && @next_reinforce_hour > 23
    invalid_properties.push('invalid value for "next_reinforce_hour", must be smaller than or equal to 23.')
  end

  if !@next_reinforce_hour.nil? && @next_reinforce_hour < 0
    invalid_properties.push('invalid value for "next_reinforce_hour", must be greater than or equal to 0.')
  end

  if !@next_reinforce_weekday.nil? && @next_reinforce_weekday > 6
    invalid_properties.push('invalid value for "next_reinforce_weekday", must be smaller than or equal to 6.')
  end

  if !@next_reinforce_weekday.nil? && @next_reinforce_weekday < 0
    invalid_properties.push('invalid value for "next_reinforce_weekday", must be greater than or equal to 0.')
  end

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

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

  if @reinforce_hour > 23
    invalid_properties.push('invalid value for "reinforce_hour", must be smaller than or equal to 23.')
  end

  if @reinforce_hour < 0
    invalid_properties.push('invalid value for "reinforce_hour", must be greater than or equal to 0.')
  end

  if !@reinforce_weekday.nil? && @reinforce_weekday > 6
    invalid_properties.push('invalid value for "reinforce_weekday", must be smaller than or equal to 6.')
  end

  if !@reinforce_weekday.nil? && @reinforce_weekday < 0
    invalid_properties.push('invalid value for "reinforce_weekday", must be greater than or equal to 0.')
  end

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

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

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



472
473
474
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 472

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



478
479
480
481
482
483
484
485
486
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 478

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



466
467
468
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 466

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 276

def valid?
  return false if @corporation_id.nil?
  return false if !@next_reinforce_hour.nil? && @next_reinforce_hour > 23
  return false if !@next_reinforce_hour.nil? && @next_reinforce_hour < 0
  return false if !@next_reinforce_weekday.nil? && @next_reinforce_weekday > 6
  return false if !@next_reinforce_weekday.nil? && @next_reinforce_weekday < 0
  return false if @profile_id.nil?
  return false if @reinforce_hour.nil?
  return false if @reinforce_hour > 23
  return false if @reinforce_hour < 0
  return false if !@reinforce_weekday.nil? && @reinforce_weekday > 6
  return false if !@reinforce_weekday.nil? && @reinforce_weekday < 0
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ['anchor_vulnerable', 'anchoring', 'armor_reinforce', 'armor_vulnerable', 'deploy_vulnerable', 'fitting_invulnerable', 'hull_reinforce', 'hull_vulnerable', 'online_deprecated', 'onlining_vulnerable', 'shield_vulnerable', 'unanchored', 'unknown'])
  return false unless state_validator.valid?(@state)
  return false if @structure_id.nil?
  return false if @system_id.nil?
  return false if @type_id.nil?
  true
end