Class: ESIClient::GetSovereigntyCampaigns200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/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



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 104

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attackers_score ⇒ Object

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



43
44
45
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 43

def attackers_score
  @attackers_score
end

#campaign_id ⇒ Object

Unique ID for this campaign.



19
20
21
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 19

def campaign_id
  @campaign_id
end

#constellation_id ⇒ Object

The constellation in which the campaign will take place.



28
29
30
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 28

def constellation_id
  @constellation_id
end

#defender_id ⇒ Object

Defending alliance, only present in Defense Events



37
38
39
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 37

def defender_id
  @defender_id
end

#defender_score ⇒ Object

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



40
41
42
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 40

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



31
32
33
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 31

def event_type
  @event_type
end

#participants ⇒ Object

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



46
47
48
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 46

def participants
  @participants
end

#solar_system_id ⇒ Object

The solar system the structure is located in.



25
26
27
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 25

def solar_system_id
  @solar_system_id
end

#start_time ⇒ Object

Time the event is scheduled to start.



34
35
36
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 34

def start_time
  @start_time
end

#structure_id ⇒ Object

The structure item ID that is related to this campaign.



22
23
24
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 22

def structure_id
  @structure_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'campaign_id' => :'Integer',
    :'structure_id' => :'Integer',
    :'solar_system_id' => :'Integer',
    :'constellation_id' => :'Integer',
    :'event_type' => :'String',
    :'start_time' => :'DateTime',
    :'defender_id' => :'Integer',
    :'defender_score' => :'Float',
    :'attackers_score' => :'Float',
    :'participants' => :'Array<GetSovereigntyCampaignsParticipant>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 210

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



261
262
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
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 261

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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 327

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 240

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


227
228
229
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



233
234
235
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 233

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



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
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 155

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



307
308
309
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 307

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



313
314
315
316
317
318
319
320
321
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 313

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



301
302
303
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 301

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



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/esi_client/models/get_sovereignty_campaigns_200_ok.rb', line 186

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