class ESIClient::GetCharactersCharacterIdOk

200 ok object

Attributes

alliance_id[RW]

The character's alliance ID

ancestry_id[RW]

ancestry_id integer

birthday[RW]

Creation date of the character

bloodline_id[RW]

bloodline_id integer

corporation_id[RW]

The character's corporation ID

description[RW]

description string

faction_id[RW]

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

gender[RW]

gender string

name[RW]

name string

race_id[RW]

race_id integer

security_status[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/esi_client/models/get_characters_character_id_ok.rb, line 259
def eql?(o)
  self == o
end
gender=(gender) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] gender Object to be assigned

# File lib/esi_client/models/get_characters_character_id_ok.rb, line 217
def gender=(gender)
  validator = EnumAttributeValidator.new('String', ['female', 'male'])
  unless validator.valid?(gender)
    fail ArgumentError, 'invalid value for "gender", must be one of #{validator.allowable_values}.'
  end
  @gender = gender
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
security_status=(security_status) click to toggle source

Custom attribute writer method with validation @param [Object] security_status Value to be assigned

# File lib/esi_client/models/get_characters_character_id_ok.rb, line 227
def security_status=(security_status)
  if !security_status.nil? && security_status > 10
    fail ArgumentError, 'invalid value for "security_status", must be smaller than or equal to 10.'
  end

  if !security_status.nil? && security_status < -10
    fail ArgumentError, 'invalid value for "security_status", must be greater than or equal to -10.'
  end

  @security_status = security_status
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/esi_client/models/get_characters_character_id_ok.rb, line 339
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/esi_client/models/get_characters_character_id_ok.rb, line 333
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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