class Comet::StorageFreeSpaceInfo

StorageFreeSpaceInfo is a typed class wrapper around the underlying Comet Server API data structure.

Attributes

available_bytes[RW]

@type [Number] available_bytes

b2[RW]

@type [Comet::B2StorageExtraInfo] b2

spanned[RW]

@type [Comet::SpannedStorageExtraInfo] spanned

unknown_json_fields[RW]

@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations

unlimited[RW]

@type [Boolean] unlimited

used_percent[RW]

@type [Number] used_percent

Public Class Methods

new() click to toggle source
# File lib/comet/models/storage_free_space_info.rb, line 35
def initialize
  clear
end

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/storage_free_space_info.rb, line 39
def clear
  @used_percent = 0.0
  @available_bytes = 0
  @spanned = Comet::SpannedStorageExtraInfo.new
  @b2 = Comet::B2StorageExtraInfo.new
  @unknown_json_fields = {}
end
from_hash(obj) click to toggle source

@param [Hash] obj The complete object as a Ruby hash

# File lib/comet/models/storage_free_space_info.rb, line 55
def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'Unlimited'
      @unlimited = v
    when 'UsedPercent'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @used_percent = v
    when 'AvailableBytes'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @available_bytes = v
    when 'Spanned'
      @spanned = Comet::SpannedStorageExtraInfo.new
      @spanned.from_hash(v)
    when 'B2'
      @b2 = Comet::B2StorageExtraInfo.new
      @b2.from_hash(v)
    else
      @unknown_json_fields[k] = v
    end
  end
end
from_json(json_string) click to toggle source

@param [String] json_string The complete object in JSON format

# File lib/comet/models/storage_free_space_info.rb, line 48
def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end
to_h() click to toggle source

@return [Hash] The complete object as a Ruby hash

# File lib/comet/models/storage_free_space_info.rb, line 101
def to_h
  to_hash
end
to_hash() click to toggle source

@return [Hash] The complete object as a Ruby hash

# File lib/comet/models/storage_free_space_info.rb, line 83
def to_hash
  ret = {}
  ret['Unlimited'] = @unlimited
  ret['UsedPercent'] = @used_percent
  ret['AvailableBytes'] = @available_bytes
  unless @spanned.nil?
    ret['Spanned'] = @spanned
  end
  unless @b2.nil?
    ret['B2'] = @b2
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end
to_json(options = {}) click to toggle source

@return [String] The complete object as a JSON string

# File lib/comet/models/storage_free_space_info.rb, line 106
def to_json(options = {})
  to_hash.to_json(options)
end