Class: Comet::StorageRoleOptions

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ StorageRoleOptions

Returns a new instance of StorageRoleOptions.



31
32
33
 
# File 'lib/comet/models/storage_role_options.rb', line 31

def initialize
  clear
end

Instance Attribute Details

#local_storage__legacy ⇒ Object

Deprecated.

This member has been deprecated since Comet version 17.3.5



23
24
25
 
# File 'lib/comet/models/storage_role_options.rb', line 23

def local_storage__legacy
  @local_storage__legacy
end

#replicate_to ⇒ Object

Returns the value of attribute replicate_to.



26
27
28
 
# File 'lib/comet/models/storage_role_options.rb', line 26

def replicate_to
  @replicate_to
end

#role_enabled ⇒ Object

Returns the value of attribute role_enabled.



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

def role_enabled
  @role_enabled
end

#storage ⇒ Object

Returns the value of attribute storage.



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

def storage
  @storage
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



29
30
31
 
# File 'lib/comet/models/storage_role_options.rb', line 29

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @storage = Comet::DestinationLocation.new
  @local_storage__legacy = []
  @replicate_to = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


50
51
52
53
54
55
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/storage_role_options.rb', line 50

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 'RoleEnabled'
      @role_enabled = v
    when 'Storage'
      @storage = Comet::DestinationLocation.new
      @storage.from_hash(v)
    when 'LocalStorage'
      if v.nil?
        @local_storage__legacy = []
      else
        @local_storage__legacy = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @local_storage__legacy[i1] = Comet::LocalStorageDirectory.new
          @local_storage__legacy[i1].from_hash(v1)
        end
      end
    when 'ReplicateTo'
      if v.nil?
        @replicate_to = []
      else
        @replicate_to = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @replicate_to[i1] = Comet::ReplicaServer.new
          @replicate_to[i1].from_hash(v1)
        end
      end
    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) 


43
44
45
46
47
 
# File 'lib/comet/models/storage_role_options.rb', line 43

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



102
103
104
 
# File 'lib/comet/models/storage_role_options.rb', line 102

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
99
 
# File 'lib/comet/models/storage_role_options.rb', line 87

def to_hash
  ret = {}
  ret['RoleEnabled'] = @role_enabled
  ret['Storage'] = @storage
  unless @local_storage__legacy.nil?
    ret['LocalStorage'] = @local_storage__legacy
  end
  ret['ReplicateTo'] = @replicate_to
  @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



107
108
109
 
# File 'lib/comet/models/storage_role_options.rb', line 107

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