Class: Comet::B2VirtualStorageRoleSettings

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ B2VirtualStorageRoleSettings

Returns a new instance of B2VirtualStorageRoleSettings.



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

def initialize
  clear
end

Instance Attribute Details

#app_key ⇒ Object

Returns the value of attribute app_key.



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

def app_key
  @app_key
end

#hide_deleted_files ⇒ Object

Returns the value of attribute hide_deleted_files.



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

def hide_deleted_files
  @hide_deleted_files
end

#key_id ⇒ Object

Returns the value of attribute key_id.



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

def key_id
  @key_id
end

#master_bucket ⇒ Object

Returns the value of attribute master_bucket.



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

def master_bucket
  @master_bucket
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @master_bucket = ''
  @key_id = ''
  @app_key = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/comet/models/b2virtual_storage_role_settings.rb', line 49

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

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

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

      @app_key = v
    when 'HideDeletedFiles'
      @hide_deleted_files = 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) 


42
43
44
45
46
 
# File 'lib/comet/models/b2virtual_storage_role_settings.rb', line 42

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



88
89
90
 
# File 'lib/comet/models/b2virtual_storage_role_settings.rb', line 88

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



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/comet/models/b2virtual_storage_role_settings.rb', line 75

def to_hash
  ret = {}
  ret['MasterBucket'] = @master_bucket
  ret['KeyID'] = @key_id
  ret['AppKey'] = @app_key
  ret['HideDeletedFiles'] = @hide_deleted_files
  @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



93
94
95
 
# File 'lib/comet/models/b2virtual_storage_role_settings.rb', line 93

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