Class: ESI::GetSovereigntyStructures200Ok

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

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
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
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 72

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

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

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

  if attributes.key?(:'structure_type_id')
    self.structure_type_id = attributes[:'structure_type_id']
  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.



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

def alliance_id
  @alliance_id
end

#solar_system_id ⇒ Object

Solar system in which the structure is located.



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

def solar_system_id
  @solar_system_id
end

#structure_id ⇒ Object

Unique item ID for this structure.



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

def structure_id
  @structure_id
end

#structure_type_id ⇒ Object

A reference to the type of structure this is.



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

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.



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

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.



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

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.



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

def vulnerable_start_time
  @vulnerable_start_time
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 39

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:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



176
177
178
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 176

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



65
66
67
68
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 52

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 149

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

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



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

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 275

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 183

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


163
164
165
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 163

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



169
170
171
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 169

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 116

def list_invalid_properties
  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:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 251

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 257

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



245
246
247
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 245

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



139
140
141
142
143
144
145
 
# File 'lib/ruby-esi/models/get_sovereignty_structures_200_ok.rb', line 139

def valid?
  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