Class: ESI::GetSovereigntyCampaigns200Ok

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attackers_score ⇒ Object

Score for all attacking parties, only present in Defense Events.



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

def attackers_score
  @attackers_score
end

#campaign_id ⇒ Object

Unique ID for this campaign.



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

def campaign_id
  @campaign_id
end

#constellation_id ⇒ Object

The constellation in which the campaign will take place.



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

def constellation_id
  @constellation_id
end

#defender_id ⇒ Object

Defending alliance, only present in Defense Events



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

def defender_id
  @defender_id
end

#defender_score ⇒ Object

Score for the defending alliance, only present in Defense Events.



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

def defender_score
  @defender_score
end

#event_type ⇒ Object

Type of event this campaign is for. tcu_defense, ihub_defense and station_defense are referred to as "Defense Events", station_freeport as "Freeport Events".



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

def event_type
  @event_type
end

#participants ⇒ Object

Alliance participating and their respective scores, only present in Freeport Events.



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

def participants
  @participants
end

#solar_system_id ⇒ Object

The solar system the structure is located in.



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

def solar_system_id
  @solar_system_id
end

#start_time ⇒ Object

Time the event is scheduled to start.



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

def start_time
  @start_time
end

#structure_id ⇒ Object

The structure item ID that is related to this campaign.



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

def structure_id
  @structure_id
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 70

def self.attribute_map
  {
    :'attackers_score' => :'attackers_score',
    :'campaign_id' => :'campaign_id',
    :'constellation_id' => :'constellation_id',
    :'defender_id' => :'defender_id',
    :'defender_score' => :'defender_score',
    :'event_type' => :'event_type',
    :'participants' => :'participants',
    :'solar_system_id' => :'solar_system_id',
    :'start_time' => :'start_time',
    :'structure_id' => :'structure_id'
  }
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



252
253
254
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 252

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 86

def self.openapi_types
  {
    :'attackers_score' => :'Object',
    :'campaign_id' => :'Object',
    :'constellation_id' => :'Object',
    :'defender_id' => :'Object',
    :'defender_score' => :'Object',
    :'event_type' => :'Object',
    :'participants' => :'Object',
    :'solar_system_id' => :'Object',
    :'start_time' => :'Object',
    :'structure_id' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attackers_score == o.attackers_score &&
      campaign_id == o.campaign_id &&
      constellation_id == o.constellation_id &&
      defender_id == o.defender_id &&
      defender_score == o.defender_score &&
      event_type == o.event_type &&
      participants == o.participants &&
      solar_system_id == o.solar_system_id &&
      start_time == o.start_time &&
      structure_id == o.structure_id
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 282

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 351

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 259

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


239
240
241
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [attackers_score, campaign_id, constellation_id, defender_id, defender_score, event_type, participants, solar_system_id, start_time, structure_id].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



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

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

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

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

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



327
328
329
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 327

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



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

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



321
322
323
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 321

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



198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ruby-esi/models/get_sovereignty_campaigns_200_ok.rb', line 198

def valid?
  return false if @campaign_id.nil?
  return false if @constellation_id.nil?
  return false if @event_type.nil?
  event_type_validator = EnumAttributeValidator.new('Object', ['tcu_defense', 'ihub_defense', 'station_defense', 'station_freeport'])
  return false unless event_type_validator.valid?(@event_type)
  return false if @solar_system_id.nil?
  return false if @start_time.nil?
  return false if @structure_id.nil?
  true
end