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
206
207
208
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.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



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

def corporation_id
  @corporation_id
end

#fuel_expires ⇒ Object

Date on which the structure will run out of fuel



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

def fuel_expires
  @fuel_expires
end

#name ⇒ Object

The structure name



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

def name
  @name
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



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

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



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

def next_reinforce_hour
  @next_reinforce_hour
end

#profile_id ⇒ Object

The id of the ACL profile for this citadel



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

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



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

def reinforce_hour
  @reinforce_hour
end

#services ⇒ Object

Contains a list of service upgrades, and their state



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

def services
  @services
end

#state ⇒ Object

state string



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

def state
  @state
end

#state_timer_end ⇒ Object

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



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

def state_timer_end
  @state_timer_end
end

#state_timer_start ⇒ Object

Date at which the structure entered it’s current state



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

def state_timer_start
  @state_timer_start
end

#structure_id ⇒ Object

The Item ID of the structure



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

def structure_id
  @structure_id
end

#system_id ⇒ Object

The solar system the structure is in



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

def system_id
  @system_id
end

#type_id ⇒ Object

The type id of the structure



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

def type_id
  @type_id
end

#unanchors_at ⇒ Object

Date at which the structure will unanchor



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

def unanchors_at
  @unanchors_at
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 85

def self.attribute_map
  {
    :'corporation_id' => :'corporation_id',
    :'fuel_expires' => :'fuel_expires',
    :'name' => :'name',
    :'next_reinforce_apply' => :'next_reinforce_apply',
    :'next_reinforce_hour' => :'next_reinforce_hour',
    :'profile_id' => :'profile_id',
    :'reinforce_hour' => :'reinforce_hour',
    :'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

.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



302
303
304
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 302

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 106

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      corporation_id == o.corporation_id &&
      fuel_expires == o.fuel_expires &&
      name == o.name &&
      next_reinforce_apply == o.next_reinforce_apply &&
      next_reinforce_hour == o.next_reinforce_hour &&
      profile_id == o.profile_id &&
      reinforce_hour == o.reinforce_hour &&
      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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 332

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



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 401

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 309

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


289
290
291
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



295
296
297
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 295

def hash
  [corporation_id, fuel_expires, name, next_reinforce_apply, next_reinforce_hour, profile_id, reinforce_hour, 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



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

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 @profile_id.nil?
    invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
  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



377
378
379
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 377

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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 383

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



371
372
373
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 371

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



243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_structures_200_ok.rb', line 243

def valid?
  return false if @corporation_id.nil?
  return false if @profile_id.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('Object', ['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