Class: Comet::BucketProperties

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BucketProperties

Returns a new instance of BucketProperties.



35
36
37
 
# File 'lib/comet/models/bucket_properties.rb', line 35

def initialize
  clear
end

Instance Attribute Details

#create_time ⇒ Object

Returns the value of attribute create_time.



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

def create_time
  @create_time
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



18
19
20
 
# File 'lib/comet/models/bucket_properties.rb', line 18

def organization_id
  @organization_id
end

#read_write_key ⇒ Object

Returns the value of attribute read_write_key.



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

def read_write_key
  @read_write_key
end

#read_write_key_format ⇒ Object

Returns the value of attribute read_write_key_format.



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

def read_write_key_format
  @read_write_key_format
end

#size ⇒ Object

Returns the value of attribute size.



30
31
32
 
# File 'lib/comet/models/bucket_properties.rb', line 30

def size
  @size
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



39
40
41
42
43
44
45
46
 
# 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) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash



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
83
84
 
# 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) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format



49
50
51
52
53
 
# 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 ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



101
102
103
 
# File 'lib/comet/models/bucket_properties.rb', line 101

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



87
88
89
90
91
92
93
94
95
96
97
98
 
# 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 = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



106
107
108
 
# File 'lib/comet/models/bucket_properties.rb', line 106

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