class Comet::BucketProperties

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

Attributes

create_time[RW]

@type [Number] create_time

organization_id[RW]

@type [String] organization_id

read_write_key[RW]

@type [String] read_write_key

read_write_key_format[RW]

@type [Number] read_write_key_format

size[RW]

@type [Comet::SizeMeasurement] size

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_properties.rb, line 35
def initialize
  clear
end

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/bucket_properties.rb, line 39
def clear
  @organization_id = ''
  @create_time = 0
  @read_write_key_format = 0
  @read_write_key = ''
  @size = Comet::SizeMeasurement.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/bucket_properties.rb, line 56
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 'OrganizationID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

      @read_write_key_format = v
    when 'ReadWriteKey'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @read_write_key = v
    when 'Size'
      @size = Comet::SizeMeasurement.new
      @size.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/bucket_properties.rb, line 49
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_properties.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/bucket_properties.rb, line 87
def to_hash
  ret = {}
  ret['OrganizationID'] = @organization_id
  ret['CreateTime'] = @create_time
  ret['ReadWriteKeyFormat'] = @read_write_key_format
  ret['ReadWriteKey'] = @read_write_key
  ret['Size'] = @size
  @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_properties.rb, line 106
def to_json(options = {})
  to_hash.to_json(options)
end