class EsiClient::GetSovereigntyStructures200Ok

200 ok object

Attributes

alliance_id[RW]

The alliance that owns the structure.

solar_system_id[RW]

Solar system in which the structure is located.

structure_id[RW]

Unique item ID for this structure.

structure_type_id[RW]

A reference to the type of structure this is.

vulnerability_occupancy_level[RW]

The occupancy level for the next or current vulnerability window. This takes into account all development indexes and capital system bonuses. Also known as Activity Defense Multiplier from in the client. It increases the time that attackers must spend using their entosis links on the structure.

vulnerable_end_time[RW]

The time at which the next or current vulnerability window ends. At the end of a vulnerability window the next window is recalculated and locked in along with the vulnerabilityOccupancyLevel. If the structure is not in 100% entosis control of the defender, it will go in to 'overtime' and stay vulnerable for as long as that situation persists. Only once the defenders have 100% entosis control and has the vulnerableEndTime passed does the vulnerability interval expire and a new one is calculated.

vulnerable_start_time[RW]

The next time at which the structure will become vulnerable. Or the start time of the current window if current time is between this and vulnerableEndTime.

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_sovereignty_structures_200_ok.rb, line 40
def self.attribute_map
  {
    :'alliance_id' => :'alliance_id',
    :'solar_system_id' => :'solar_system_id',
    :'structure_id' => :'structure_id',
    :'structure_type_id' => :'structure_type_id',
    :'vulnerability_occupancy_level' => :'vulnerability_occupancy_level',
    :'vulnerable_end_time' => :'vulnerable_end_time',
    :'vulnerable_start_time' => :'vulnerable_start_time'
  }
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_sovereignty_structures_200_ok.rb, line 67
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?(:'alliance_id')
    self.alliance_id = attributes[:'alliance_id']
  end

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/esi-ruby/models/get_sovereignty_structures_200_ok.rb, line 53
def self.swagger_types
  {
    :'alliance_id' => :'Integer',
    :'solar_system_id' => :'Integer',
    :'structure_id' => :'Integer',
    :'structure_type_id' => :'Integer',
    :'vulnerability_occupancy_level' => :'Float',
    :'vulnerable_end_time' => :'DateTime',
    :'vulnerable_start_time' => :'DateTime'
  }
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_sovereignty_structures_200_ok.rb, line 138
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alliance_id == o.alliance_id &&
      solar_system_id == o.solar_system_id &&
      structure_id == o.structure_id &&
      structure_type_id == o.structure_type_id &&
      vulnerability_occupancy_level == o.vulnerability_occupancy_level &&
      vulnerable_end_time == o.vulnerable_end_time &&
      vulnerable_start_time == o.vulnerable_start_time
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_sovereignty_structures_200_ok.rb, line 186
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_sovereignty_structures_200_ok.rb, line 252
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_sovereignty_structures_200_ok.rb, line 165
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-ruby/models/get_sovereignty_structures_200_ok.rb, line 152
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_sovereignty_structures_200_ok.rb, line 158
def hash
  [alliance_id, solar_system_id, structure_id, structure_type_id, vulnerability_occupancy_level, vulnerable_end_time, vulnerable_start_time].hash
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_sovereignty_structures_200_ok.rb, line 105
def list_invalid_properties
  invalid_properties = Array.new
  if @alliance_id.nil?
    invalid_properties.push("invalid value for 'alliance_id', alliance_id cannot be nil.")
  end

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

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

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

  return invalid_properties
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_sovereignty_structures_200_ok.rb, line 232
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_sovereignty_structures_200_ok.rb, line 238
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_sovereignty_structures_200_ok.rb, line 226
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-ruby/models/get_sovereignty_structures_200_ok.rb, line 128
def valid?
  return false if @alliance_id.nil?
  return false if @solar_system_id.nil?
  return false if @structure_id.nil?
  return false if @structure_type_id.nil?
  return true
end