class EsiClient::GetCharactersCharacterIdMailLabelsLabel

label object

Attributes

color[RW]

color string

label_id[RW]

label_id integer

name[RW]

name string

unread_count[RW]

unread_count integer

Public Class Methods

attribute_map() click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 52
def self.attribute_map
  {
    :'color' => :'color',
    :'label_id' => :'label_id',
    :'name' => :'name',
    :'unread_count' => :'unread_count'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 73
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?(:'color')
    self.color = attributes[:'color']
  else
    self.color = "#ffffff"
  end

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 62
def self.swagger_types
  {
    :'color' => :'String',
    :'label_id' => :'Integer',
    :'name' => :'String',
    :'unread_count' => :'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-ruby/models/get_characters_character_id_mail_labels_label.rb, line 174
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      color == o.color &&
      label_id == o.label_id &&
      name == o.name &&
      unread_count == o.unread_count
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-ruby/models/get_characters_character_id_mail_labels_label.rb, line 219
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-ruby/models/get_characters_character_id_mail_labels_label.rb, line 285
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-ruby/models/get_characters_character_id_mail_labels_label.rb, line 198
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
color=(color) click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 131
def color=(color)
  validator = EnumAttributeValidator.new('String', ["#ffffff", "#ffff01", "#ff6600", "#fe0000", "#9a0000", "#660066", "#0000fe", "#0099ff", "#01ffff", "#00ff33", "#349800", "#006634", "#666666", "#999999", "#e6e6e6", "#ffffcd", "#99ffff", "#ccff9a"])
  unless validator.valid?(color)
    fail ArgumentError, "invalid value for 'color', must be one of #{validator.allowable_values}."
  end
  @color = color
end
eql?(o) click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 185
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 191
def hash
  [color, label_id, name, unread_count].hash
end
label_id=(label_id) click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 141
def label_id=(label_id)

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

  @label_id = label_id
end
list_invalid_properties() click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 101
def list_invalid_properties
  invalid_properties = Array.new
  if !@label_id.nil? && @label_id < 0
    invalid_properties.push("invalid value for 'label_id', must be greater than or equal to 0.")
  end

  if !@name.nil? && @name.to_s.length > 40
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 40.")
  end

  if !@unread_count.nil? && @unread_count < 0
    invalid_properties.push("invalid value for 'unread_count', must be greater than or equal to 0.")
  end

  return invalid_properties
end
name=(name) click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 152
def name=(name)

  if !name.nil? && name.to_s.length > 40
    fail ArgumentError, "invalid value for 'name', the character length must be smaller than or equal to 40."
  end

  @name = name
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-ruby/models/get_characters_character_id_mail_labels_label.rb, line 265
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-ruby/models/get_characters_character_id_mail_labels_label.rb, line 271
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-ruby/models/get_characters_character_id_mail_labels_label.rb, line 259
def to_s
  to_hash.to_s
end
unread_count=(unread_count) click to toggle source

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

# File lib/esi-ruby/models/get_characters_character_id_mail_labels_label.rb, line 163
def unread_count=(unread_count)

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

  @unread_count = unread_count
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-ruby/models/get_characters_character_id_mail_labels_label.rb, line 120
def valid?
  color_validator = EnumAttributeValidator.new('String', ["#ffffff", "#ffff01", "#ff6600", "#fe0000", "#9a0000", "#660066", "#0000fe", "#0099ff", "#01ffff", "#00ff33", "#349800", "#006634", "#666666", "#999999", "#e6e6e6", "#ffffcd", "#99ffff", "#ccff9a"])
  return false unless color_validator.valid?(@color)
  return false if !@label_id.nil? && @label_id < 0
  return false if !@name.nil? && @name.to_s.length > 40
  return false if !@unread_count.nil? && @unread_count < 0
  return true
end