Class: ESI::GetSovereigntyStructures200Ok

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

Overview

200 ok object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetSovereigntyStructures200Ok

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



84
85
86
87
88
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
126
127
128
129
130
131
132
133
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ESI::GetSovereigntyStructures200Ok` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ESI::GetSovereigntyStructures200Ok`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'alliance_id')
    self.alliance_id = attributes[:'alliance_id']
  else
    self.alliance_id = nil
  end

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

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

  if attributes.key?(:'structure_type_id')
    self.structure_type_id = attributes[:'structure_type_id']
  else
    self.structure_type_id = nil
  end

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

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

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

Instance Attribute Details

#alliance_id ⇒ Object

The alliance that owns the structure.



20
21
22
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 20

def alliance_id
  @alliance_id
end

#solar_system_id ⇒ Object

Solar system in which the structure is located.



23
24
25
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 23

def solar_system_id
  @solar_system_id
end

#structure_id ⇒ Object

Unique item ID for this structure.



26
27
28
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 26

def structure_id
  @structure_id
end

#structure_type_id ⇒ Object

A reference to the type of structure this is.



29
30
31
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 29

def structure_type_id
  @structure_type_id
end

#vulnerability_occupancy_level ⇒ Object

The occupancy level for the next or current vulnerability window. This takes into account all development indexes and capital system bonuses. Also known as Activity Defense Multiplier from in the client. It increases the time that attackers must spend using their entosis links on the structure.



32
33
34
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 32

def vulnerability_occupancy_level
  @vulnerability_occupancy_level
end

#vulnerable_end_time ⇒ Object

The time at which the next or current vulnerability window ends. At the end of a vulnerability window the next window is recalculated and locked in along with the vulnerabilityOccupancyLevel. If the structure is not in 100% entosis control of the defender, it will go in to ‘overtime’ and stay vulnerable for as long as that situation persists. Only once the defenders have 100% entosis control and has the vulnerableEndTime passed does the vulnerability interval expire and a new one is calculated.



35
36
37
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 35

def vulnerable_end_time
  @vulnerable_end_time
end

#vulnerable_start_time ⇒ Object

The next time at which the structure will become vulnerable. Or the start time of the current window if current time is between this and vulnerableEndTime.



38
39
40
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 38

def vulnerable_start_time
  @vulnerable_start_time
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 263

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ESI.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 59

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 41

def self.attribute_map
  {
    :'alliance_id' => :'alliance_id',
    :'solar_system_id' => :'solar_system_id',
    :'structure_id' => :'structure_id',
    :'structure_type_id' => :'structure_type_id',
    :'vulnerability_occupancy_level' => :'vulnerability_occupancy_level',
    :'vulnerable_end_time' => :'vulnerable_end_time',
    :'vulnerable_start_time' => :'vulnerable_start_time'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 239

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'alliance_id' => :'Integer',
    :'solar_system_id' => :'Integer',
    :'structure_id' => :'Integer',
    :'structure_type_id' => :'Integer',
    :'vulnerability_occupancy_level' => :'Float',
    :'vulnerable_end_time' => :'Time',
    :'vulnerable_start_time' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alliance_id == o.alliance_id &&
      solar_system_id == o.solar_system_id &&
      structure_id == o.structure_id &&
      structure_type_id == o.structure_type_id &&
      vulnerability_occupancy_level == o.vulnerability_occupancy_level &&
      vulnerable_end_time == o.vulnerable_end_time &&
      vulnerable_start_time == o.vulnerable_start_time
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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 334

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method

Parameters:

  • to be compared

Returns:



226
227
228
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



232
233
234
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 232

def hash
  [alliance_id, solar_system_id, structure_id, structure_type_id, vulnerability_occupancy_level, vulnerable_end_time, vulnerable_start_time].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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 137

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @alliance_id.nil?
    invalid_properties.push('invalid value for "alliance_id", alliance_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 @structure_id.nil?
    invalid_properties.push('invalid value for "structure_id", structure_id cannot be nil.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



310
311
312
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 310

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



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

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 presentation of the object



304
305
306
 
# File 'lib/ruby-esi/models/get_sovereignty_structures200_ok.rb', line 304

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @alliance_id.nil?
  return false if @solar_system_id.nil?
  return false if @structure_id.nil?
  return false if @structure_type_id.nil?
  true
end