Class: Comet::RemoteStorageOption

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RemoteStorageOption

Returns a new instance of RemoteStorageOption.



53
54
55
 
# File 'lib/comet/models/remote_storage_option.rb', line 53

def initialize
  clear
end

Instance Attribute Details

#b2 ⇒ Object

Returns the value of attribute b2.



36
37
38
 
# File 'lib/comet/models/remote_storage_option.rb', line 36

def b2
  @b2
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#ldap ⇒ Object

Returns the value of attribute ldap.



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

def ldap
  @ldap
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#rebrand_storage ⇒ Object

Returns the value of attribute rebrand_storage.



48
49
50
 
# File 'lib/comet/models/remote_storage_option.rb', line 48

def rebrand_storage
  @rebrand_storage
end

#remote_address ⇒ Object

Returns the value of attribute remote_address.



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

def remote_address
  @remote_address
end

#storage_limit_bytes ⇒ Object

Returns the value of attribute storage_limit_bytes.



45
46
47
 
# File 'lib/comet/models/remote_storage_option.rb', line 45

def storage_limit_bytes
  @storage_limit_bytes
end

#storage_limit_enabled ⇒ Object

Returns the value of attribute storage_limit_enabled.



42
43
44
 
# File 'lib/comet/models/remote_storage_option.rb', line 42

def storage_limit_enabled
  @storage_limit_enabled
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



51
52
53
 
# File 'lib/comet/models/remote_storage_option.rb', line 51

def unknown_json_fields
  @unknown_json_fields
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end

#wasabi ⇒ Object

Returns the value of attribute wasabi.



39
40
41
 
# File 'lib/comet/models/remote_storage_option.rb', line 39

def wasabi
  @wasabi
end

Instance Method Details

#clear ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/comet/models/remote_storage_option.rb', line 57

def clear
  @type = ''
  @description = ''
  @remote_address = ''
  @username = ''
  @password = ''
  @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
  @b2 = Comet::B2VirtualStorageRoleSettings.new
  @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
  @storage_limit_bytes = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/comet/models/remote_storage_option.rb', line 78

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

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

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

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

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

      @password = v
    when 'LDAP'
      @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
      @ldap.from_hash(v)
    when 'B2'
      @b2 = Comet::B2VirtualStorageRoleSettings.new
      @b2.from_hash(v)
    when 'Wasabi'
      @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
      @wasabi.from_hash(v)
    when 'StorageLimitEnabled'
      @storage_limit_enabled = v
    when 'StorageLimitBytes'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @storage_limit_bytes = v
    when 'RebrandStorage'
      @rebrand_storage = 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) 


71
72
73
74
75
 
# File 'lib/comet/models/remote_storage_option.rb', line 71

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



159
160
161
 
# File 'lib/comet/models/remote_storage_option.rb', line 159

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/comet/models/remote_storage_option.rb', line 127

def to_hash
  ret = {}
  ret['Type'] = @type
  ret['Description'] = @description
  unless @remote_address.nil?
    ret['RemoteAddress'] = @remote_address
  end
  unless @username.nil?
    ret['Username'] = @username
  end
  unless @password.nil?
    ret['Password'] = @password
  end
  unless @ldap.nil?
    ret['LDAP'] = @ldap
  end
  unless @b2.nil?
    ret['B2'] = @b2
  end
  unless @wasabi.nil?
    ret['Wasabi'] = @wasabi
  end
  ret['StorageLimitEnabled'] = @storage_limit_enabled
  ret['StorageLimitBytes'] = @storage_limit_bytes
  ret['RebrandStorage'] = @rebrand_storage
  @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



164
165
166
 
# File 'lib/comet/models/remote_storage_option.rb', line 164

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