Class: Comet::BucketUsageInfo

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BucketUsageInfo

Returns a new instance of BucketUsageInfo.



29
30
31
 
# File 'lib/comet/models/bucket_usage_info.rb', line 29

def initialize
  clear
end

Instance Attribute Details

#access_key ⇒ Object

Returns the value of attribute access_key.



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

def access_key
  @access_key
end

#exists_on_servers ⇒ Object

The servers where this bucket was found. The 0-based indexes here correspond to the entries inside ConstellationRoleOptions->Servers.



21
22
23
 
# File 'lib/comet/models/bucket_usage_info.rb', line 21

def exists_on_servers
  @exists_on_servers
end

#in_use_by ⇒ Object

Returns the value of attribute in_use_by.



24
25
26
 
# File 'lib/comet/models/bucket_usage_info.rb', line 24

def in_use_by
  @in_use_by
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



27
28
29
 
# File 'lib/comet/models/bucket_usage_info.rb', line 27

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/comet/models/bucket_usage_info.rb', line 33

def clear
  @access_key = ''
  @exists_on_servers = []
  @in_use_by = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


48
49
50
51
52
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
79
80
81
82
 
# File 'lib/comet/models/bucket_usage_info.rb', line 48

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 'AccessKey'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @access_key = v
    when 'ExistsOnServers'
      if v.nil?
        @exists_on_servers = []
      else
        @exists_on_servers = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @exists_on_servers[i1] = v1
        end
      end
    when 'InUseBy'
      if v.nil?
        @in_use_by = []
      else
        @in_use_by = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @in_use_by[i1] = Comet::UserOnServer.new
          @in_use_by[i1].from_hash(v1)
        end
      end
    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) 


41
42
43
44
45
 
# File 'lib/comet/models/bucket_usage_info.rb', line 41

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



97
98
99
 
# File 'lib/comet/models/bucket_usage_info.rb', line 97

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



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/comet/models/bucket_usage_info.rb', line 85

def to_hash
  ret = {}
  ret['AccessKey'] = @access_key
  ret['ExistsOnServers'] = @exists_on_servers
  ret['InUseBy'] = @in_use_by
  @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



102
103
104
 
# File 'lib/comet/models/bucket_usage_info.rb', line 102

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