Class: Comet::RemoteServerAddress

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeRemoteServerAddress

Returns a new instance of RemoteServerAddress.



44
45
46
# File 'lib/comet/models/remote_server_address.rb', line 44

def initialize
  clear
end

Instance Attribute Details

#b2Object

Returns the value of attribute b2.



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

def b2
  @b2
end

#descriptionObject

Returns the value of attribute description.



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

def description
  @description
end

#ldapObject

Returns the value of attribute ldap.



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

def ldap
  @ldap
end

#passwordObject

Returns the value of attribute password.



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

def password
  @password
end

#remote_addressObject

Returns the value of attribute remote_address.



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

def remote_address
  @remote_address
end

#typeObject

Returns the value of attribute type.



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

def type
  @type
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#usernameObject

Returns the value of attribute username.



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

def username
  @username
end

#wasabiObject

Returns the value of attribute wasabi.



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

def wasabi
  @wasabi
end

Instance Method Details

#clearObject



48
49
50
51
52
53
54
55
56
57
58
# File 'lib/comet/models/remote_server_address.rb', line 48

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

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


68
69
70
71
72
73
74
75
76
77
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
# File 'lib/comet/models/remote_server_address.rb', line 68

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)
    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)


61
62
63
64
65
# File 'lib/comet/models/remote_server_address.rb', line 61

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_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



138
139
140
# File 'lib/comet/models/remote_server_address.rb', line 138

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/comet/models/remote_server_address.rb', line 109

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
  @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



143
144
145
# File 'lib/comet/models/remote_server_address.rb', line 143

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