Class: EsiClient::GetSearchOk

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

Overview

200 ok object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetSearchOk

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'agent')
    if (value = attributes[:'agent']).is_a?(Array)
      self.agent = value
    end
  end

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#agent ⇒ Object

agent array



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

def agent
  @agent
end

#alliance ⇒ Object

alliance array



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

def alliance
  @alliance
end

#character ⇒ Object

character array



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

def character
  @character
end

#constellation ⇒ Object

constellation array



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

def constellation
  @constellation
end

#corporation ⇒ Object

corporation array



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

def corporation
  @corporation
end

#faction ⇒ Object

faction array



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

def faction
  @faction
end

#inventorytype ⇒ Object

inventorytype array



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

def inventorytype
  @inventorytype
end

#region ⇒ Object

region array



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

def region
  @region
end

#solarsystem ⇒ Object

solarsystem array



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

def solarsystem
  @solarsystem
end

#station ⇒ Object

station array



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

def station
  @station
end

#wormhole ⇒ Object

wormhole array



48
49
50
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 48

def wormhole
  @wormhole
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'agent' => :'agent',
    :'alliance' => :'alliance',
    :'character' => :'character',
    :'constellation' => :'constellation',
    :'corporation' => :'corporation',
    :'faction' => :'faction',
    :'inventorytype' => :'inventorytype',
    :'region' => :'region',
    :'solarsystem' => :'solarsystem',
    :'station' => :'station',
    :'wormhole' => :'wormhole'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'agent' => :'Array<Integer>',
    :'alliance' => :'Array<Integer>',
    :'character' => :'Array<Integer>',
    :'constellation' => :'Array<Integer>',
    :'corporation' => :'Array<Integer>',
    :'faction' => :'Array<Integer>',
    :'inventorytype' => :'Array<Integer>',
    :'region' => :'Array<Integer>',
    :'solarsystem' => :'Array<Integer>',
    :'station' => :'Array<Integer>',
    :'wormhole' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 176

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 &&
      inventorytype == o.inventorytype &&
      region == o.region &&
      solarsystem == o.solarsystem &&
      station == o.station &&
      wormhole == o.wormhole
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 228

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 294

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 207

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


194
195
196
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 200

def hash
  [agent, alliance, character, constellation, corporation, faction, inventorytype, region, solarsystem, station, wormhole].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



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

def list_invalid_properties
  invalid_properties = Array.new
  return 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



274
275
276
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 274

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



280
281
282
283
284
285
286
287
288
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 280

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



268
269
270
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 268

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



170
171
172
 
# File 'lib/esi-ruby/models/get_search_ok.rb', line 170

def valid?
  return true
end