Class: ESI::GetCharactersCharacterIdSearchOk

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

Overview

200 ok object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCharactersCharacterIdSearchOk

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
152
153
154
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
183
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 104

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#agent ⇒ Object

agent array



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

def agent
  @agent
end

#alliance ⇒ Object

alliance array



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

def alliance
  @alliance
end

#character ⇒ Object

character array



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

def character
  @character
end

#constellation ⇒ Object

constellation array



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

def constellation
  @constellation
end

#corporation ⇒ Object

corporation array



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

def corporation
  @corporation
end

#faction ⇒ Object

faction array



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

def faction
  @faction
end

#inventory_type ⇒ Object

inventory_type array



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

def inventory_type
  @inventory_type
end

#region ⇒ Object

region array



41
42
43
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 41

def region
  @region
end

#solar_system ⇒ Object

solar_system array



44
45
46
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 44

def solar_system
  @solar_system
end

#station ⇒ Object

station array



47
48
49
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 47

def station
  @station
end

#structure ⇒ Object

structure array



50
51
52
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 50

def structure
  @structure
end

Class Method Details

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



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 466

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



70
71
72
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 53

def self.attribute_map
  {
    :'agent' => :'agent',
    :'alliance' => :'alliance',
    :'character' => :'character',
    :'constellation' => :'constellation',
    :'corporation' => :'corporation',
    :'faction' => :'faction',
    :'inventory_type' => :'inventory_type',
    :'region' => :'region',
    :'solar_system' => :'solar_system',
    :'station' => :'station',
    :'structure' => :'structure'
  }
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



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 442

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



97
98
99
100
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 80

def self.openapi_types
  {
    :'agent' => :'Array<Integer>',
    :'alliance' => :'Array<Integer>',
    :'character' => :'Array<Integer>',
    :'constellation' => :'Array<Integer>',
    :'corporation' => :'Array<Integer>',
    :'faction' => :'Array<Integer>',
    :'inventory_type' => :'Array<Integer>',
    :'region' => :'Array<Integer>',
    :'solar_system' => :'Array<Integer>',
    :'station' => :'Array<Integer>',
    :'structure' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 411

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agent == o.agent &&
      alliance == o.alliance &&
      character == o.character &&
      constellation == o.constellation &&
      corporation == o.corporation &&
      faction == o.faction &&
      inventory_type == o.inventory_type &&
      region == o.region &&
      solar_system == o.solar_system &&
      station == o.station &&
      structure == o.structure
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



537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 537

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


429
430
431
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 429

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



435
436
437
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 435

def hash
  [agent, alliance, character, constellation, corporation, faction, inventory_type, region, solar_system, station, structure].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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
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
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 187

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@agent.nil? && @agent.length > 500
    invalid_properties.push('invalid value for "agent", number of items must be less than or equal to 500.')
  end

  if !@alliance.nil? && @alliance.length > 500
    invalid_properties.push('invalid value for "alliance", number of items must be less than or equal to 500.')
  end

  if !@character.nil? && @character.length > 500
    invalid_properties.push('invalid value for "character", number of items must be less than or equal to 500.')
  end

  if !@constellation.nil? && @constellation.length > 500
    invalid_properties.push('invalid value for "constellation", number of items must be less than or equal to 500.')
  end

  if !@corporation.nil? && @corporation.length > 500
    invalid_properties.push('invalid value for "corporation", number of items must be less than or equal to 500.')
  end

  if !@faction.nil? && @faction.length > 500
    invalid_properties.push('invalid value for "faction", number of items must be less than or equal to 500.')
  end

  if !@inventory_type.nil? && @inventory_type.length > 500
    invalid_properties.push('invalid value for "inventory_type", number of items must be less than or equal to 500.')
  end

  if !@region.nil? && @region.length > 500
    invalid_properties.push('invalid value for "region", number of items must be less than or equal to 500.')
  end

  if !@solar_system.nil? && @solar_system.length > 500
    invalid_properties.push('invalid value for "solar_system", number of items must be less than or equal to 500.')
  end

  if !@station.nil? && @station.length > 500
    invalid_properties.push('invalid value for "station", number of items must be less than or equal to 500.')
  end

  if !@structure.nil? && @structure.length > 500
    invalid_properties.push('invalid value for "structure", number of items must be less than or equal to 500.')
  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



513
514
515
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 513

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



519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 519

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



507
508
509
 
# File 'lib/ruby-esi/models/get_characters_character_id_search_ok.rb', line 507

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@agent.nil? && @agent.length > 500
  return false if !@alliance.nil? && @alliance.length > 500
  return false if !@character.nil? && @character.length > 500
  return false if !@constellation.nil? && @constellation.length > 500
  return false if !@corporation.nil? && @corporation.length > 500
  return false if !@faction.nil? && @faction.length > 500
  return false if !@inventory_type.nil? && @inventory_type.length > 500
  return false if !@region.nil? && @region.length > 500
  return false if !@solar_system.nil? && @solar_system.length > 500
  return false if !@station.nil? && @station.length > 500
  return false if !@structure.nil? && @structure.length > 500
  true
end