class LinstorClient::StoragePool

Contains information about a storage pool. If state is ‘Error` check the storage pool object path for detailed error description: /v1/nodes/{nodename}/storage-pools/{poolname}

Attributes

free_capacity[RW]

Kibi - read only

free_space_mgr_name[RW]

read only

node_name[RW]
props[RW]

A string to string property map.

provider_kind[RW]
reports[RW]

Currently known report messages for this storage pool

static_traits[RW]

read only map of static storage pool traits

storage_pool_name[RW]
supports_snapshots[RW]

true if the storage pool supports snapshots. false otherwise

total_capacity[RW]

Kibi - read only

uuid[RW]

unique object id

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/ruby-linstor-client/models/storage_pool.rb, line 67
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/ruby-linstor-client/models/storage_pool.rb, line 50
def self.attribute_map
  {
    :'storage_pool_name' => :'storage_pool_name',
    :'node_name' => :'node_name',
    :'provider_kind' => :'provider_kind',
    :'props' => :'props',
    :'static_traits' => :'static_traits',
    :'free_capacity' => :'free_capacity',
    :'total_capacity' => :'total_capacity',
    :'free_space_mgr_name' => :'free_space_mgr_name',
    :'uuid' => :'uuid',
    :'reports' => :'reports',
    :'supports_snapshots' => :'supports_snapshots'
  }
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/ruby-linstor-client/models/storage_pool.rb, line 216
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/ruby-linstor-client/models/storage_pool.rb, line 96
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LinstorClient::StoragePool` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `LinstorClient::StoragePool`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'storage_pool_name')
    self.storage_pool_name = attributes[:'storage_pool_name']
  end

  if attributes.key?(:'node_name')
    self.node_name = attributes[:'node_name']
  end

  if attributes.key?(:'provider_kind')
    self.provider_kind = attributes[:'provider_kind']
  end

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

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

  if attributes.key?(:'free_capacity')
    self.free_capacity = attributes[:'free_capacity']
  end

  if attributes.key?(:'total_capacity')
    self.total_capacity = attributes[:'total_capacity']
  end

  if attributes.key?(:'free_space_mgr_name')
    self.free_space_mgr_name = attributes[:'free_space_mgr_name']
  end

  if attributes.key?(:'uuid')
    self.uuid = attributes[:'uuid']
  end

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

  if attributes.key?(:'supports_snapshots')
    self.supports_snapshots = attributes[:'supports_snapshots']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/ruby-linstor-client/models/storage_pool.rb, line 89
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/ruby-linstor-client/models/storage_pool.rb, line 72
def self.openapi_types
  {
    :'storage_pool_name' => :'String',
    :'node_name' => :'String',
    :'provider_kind' => :'ProviderKind',
    :'props' => :'Hash<String, String>',
    :'static_traits' => :'Hash<String, String>',
    :'free_capacity' => :'Integer',
    :'total_capacity' => :'Integer',
    :'free_space_mgr_name' => :'String',
    :'uuid' => :'String',
    :'reports' => :'Array<ApiCallRc>',
    :'supports_snapshots' => :'Boolean'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ruby-linstor-client/models/storage_pool.rb, line 185
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      storage_pool_name == o.storage_pool_name &&
      node_name == o.node_name &&
      provider_kind == o.provider_kind &&
      props == o.props &&
      static_traits == o.static_traits &&
      free_capacity == o.free_capacity &&
      total_capacity == o.total_capacity &&
      free_space_mgr_name == o.free_space_mgr_name &&
      uuid == o.uuid &&
      reports == o.reports &&
      supports_snapshots == o.supports_snapshots
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/ruby-linstor-client/models/storage_pool.rb, line 246
def _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 = LinstorClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/ruby-linstor-client/models/storage_pool.rb, line 317
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/ruby-linstor-client/models/storage_pool.rb, line 223
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end
eql?(o) click to toggle source

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

# File lib/ruby-linstor-client/models/storage_pool.rb, line 203
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ruby-linstor-client/models/storage_pool.rb, line 209
def hash
  [storage_pool_name, node_name, provider_kind, props, static_traits, free_capacity, total_capacity, free_space_mgr_name, uuid, reports, supports_snapshots].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/ruby-linstor-client/models/storage_pool.rb, line 162
def list_invalid_properties
  invalid_properties = Array.new
  if @storage_pool_name.nil?
    invalid_properties.push('invalid value for "storage_pool_name", storage_pool_name cannot be nil.')
  end

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

  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/ruby-linstor-client/models/storage_pool.rb, line 293
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/ruby-linstor-client/models/storage_pool.rb, line 299
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() click to toggle source

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

# File lib/ruby-linstor-client/models/storage_pool.rb, line 287
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/ruby-linstor-client/models/storage_pool.rb, line 177
def valid?
  return false if @storage_pool_name.nil?
  return false if @provider_kind.nil?
  true
end