Class: ESIClient::GetCharactersCharacterIdOk

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/models/get_characters_character_id_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 = {}) ⇒ GetCharactersCharacterIdOk

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alliance_id ⇒ Object

The character’s alliance ID



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

def alliance_id
  @alliance_id
end

#ancestry_id ⇒ Object

ancestry_id integer



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

def ancestry_id
  @ancestry_id
end

#birthday ⇒ Object

Creation date of the character



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

def birthday
  @birthday
end

#bloodline_id ⇒ Object

bloodline_id integer



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

def bloodline_id
  @bloodline_id
end

#corporation_id ⇒ Object

The character’s corporation ID



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

def corporation_id
  @corporation_id
end

#description ⇒ Object

description string



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

def description
  @description
end

#faction_id ⇒ Object

ID of the faction the character is fighting for, if the character is enlisted in Factional Warfare



49
50
51
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 49

def faction_id
  @faction_id
end

#gender ⇒ Object

gender string



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

def gender
  @gender
end

#name ⇒ Object

name string



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

def name
  @name
end

#race_id ⇒ Object

race_id integer



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

def race_id
  @race_id
end

#security_status ⇒ Object

security_status number



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

def security_status
  @security_status
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 74

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'corporation_id' => :'corporation_id',
    :'alliance_id' => :'alliance_id',
    :'birthday' => :'birthday',
    :'gender' => :'gender',
    :'race_id' => :'race_id',
    :'bloodline_id' => :'bloodline_id',
    :'ancestry_id' => :'ancestry_id',
    :'security_status' => :'security_status',
    :'faction_id' => :'faction_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 91

def self.swagger_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'corporation_id' => :'Integer',
    :'alliance_id' => :'Integer',
    :'birthday' => :'DateTime',
    :'gender' => :'String',
    :'race_id' => :'Integer',
    :'bloodline_id' => :'Integer',
    :'ancestry_id' => :'Integer',
    :'security_status' => :'Float',
    :'faction_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      corporation_id == o.corporation_id &&
      alliance_id == o.alliance_id &&
      birthday == o.birthday &&
      gender == o.gender &&
      race_id == o.race_id &&
      bloodline_id == o.bloodline_id &&
      ancestry_id == o.ancestry_id &&
      security_status == o.security_status &&
      faction_id == o.faction_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



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
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 293

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 359

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 272

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


259
260
261
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



265
266
267
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 265

def hash
  [name, description, corporation_id, alliance_id, birthday, gender, race_id, bloodline_id, ancestry_id, security_status, faction_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



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

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

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

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

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

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

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

  if !@security_status.nil? && @security_status > 10
    invalid_properties.push('invalid value for "security_status", must be smaller than or equal to 10.')
  end

  if !@security_status.nil? && @security_status < -10
    invalid_properties.push('invalid value for "security_status", must be greater than or equal to -10.')
  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



339
340
341
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 339

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



345
346
347
348
349
350
351
352
353
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 345

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



333
334
335
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 333

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



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/esi_client/models/get_characters_character_id_ok.rb', line 201

def valid?
  return false if @name.nil?
  return false if @corporation_id.nil?
  return false if @birthday.nil?
  return false if @gender.nil?
  gender_validator = EnumAttributeValidator.new('String', ['female', 'male'])
  return false unless gender_validator.valid?(@gender)
  return false if @race_id.nil?
  return false if @bloodline_id.nil?
  return false if !@security_status.nil? && @security_status > 10
  return false if !@security_status.nil? && @security_status < -10
  true
end