class Comet::BucketUsageInfo

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

Attributes

exists_on_servers[RW]

@type [Array<Number>] exists_on_servers

in_use_by[RW]

@type [Array<Comet::UserOnServer>] in_use_by

unknown_json_fields[RW]

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

Public Class Methods

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

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/bucket_usage_info.rb, line 30
def clear
  @exists_on_servers = []
  @in_use_by = []
  @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/bucket_usage_info.rb, line 44
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 '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) click to toggle source

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

# File lib/comet/models/bucket_usage_info.rb, line 37
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/bucket_usage_info.rb, line 88
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/bucket_usage_info.rb, line 77
def to_hash
  ret = {}
  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 = {}) click to toggle source

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

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