Class: Comet::StorageFreeSpaceInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/storage_free_space_info.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ StorageFreeSpaceInfo

Returns a new instance of StorageFreeSpaceInfo.



33
34
35
 
# File 'lib/comet/models/storage_free_space_info.rb', line 33

def initialize
  clear
end

Instance Attribute Details

#available_bytes ⇒ Object

Returns the value of attribute available_bytes.



22
23
24
 
# File 'lib/comet/models/storage_free_space_info.rb', line 22

def available_bytes
  @available_bytes
end

#b2 ⇒ Object

Returns the value of attribute b2.



28
29
30
 
# File 'lib/comet/models/storage_free_space_info.rb', line 28

def b2
  @b2
end

#spanned ⇒ Object

Returns the value of attribute spanned.



25
26
27
 
# File 'lib/comet/models/storage_free_space_info.rb', line 25

def spanned
  @spanned
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



31
32
33
 
# File 'lib/comet/models/storage_free_space_info.rb', line 31

def unknown_json_fields
  @unknown_json_fields
end

#unlimited ⇒ Object

Returns the value of attribute unlimited.



16
17
18
 
# File 'lib/comet/models/storage_free_space_info.rb', line 16

def unlimited
  @unlimited
end

#used_percent ⇒ Object

Returns the value of attribute used_percent.



19
20
21
 
# File 'lib/comet/models/storage_free_space_info.rb', line 19

def used_percent
  @used_percent
end

Instance Method Details

#clear ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/comet/models/storage_free_space_info.rb', line 37

def clear
  @used_percent = 0.0
  @available_bytes = 0
  @spanned = Comet::SpannedStorageExtraInfo.new
  @b2 = Comet::B2StorageExtraInfo.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/comet/models/storage_free_space_info.rb', line 53

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) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


46
47
48
49
50
 
# File 'lib/comet/models/storage_free_space_info.rb', line 46

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 ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



99
100
101
 
# File 'lib/comet/models/storage_free_space_info.rb', line 99

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/comet/models/storage_free_space_info.rb', line 81

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 = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



104
105
106
 
# File 'lib/comet/models/storage_free_space_info.rb', line 104

def to_json(options = {})
  to_hash.to_json(options)
end