Class: Comet::ConstellationRoleOptions

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConstellationRoleOptions

Returns a new instance of ConstellationRoleOptions.



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

def initialize
  clear
end

Instance Attribute Details

#delete_unused_dataObject

Returns the value of attribute delete_unused_data.



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

def delete_unused_data
  @delete_unused_data
end

#role_enabledObject

Returns the value of attribute role_enabled.



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

def role_enabled
  @role_enabled
end

#serversObject

Returns the value of attribute servers.



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

def servers
  @servers
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



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

def clear
  @servers = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/comet/models/constellation_role_options.rb', line 44

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 'DeleteUnusedData'
      @delete_unused_data = v
    when 'Servers'
      if v.nil?
        @servers = []
      else
        @servers = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @servers[i1] = Comet::RemoteServerAddress.new
          @servers[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)


37
38
39
40
41
# File 'lib/comet/models/constellation_role_options.rb', line 37

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



82
83
84
# File 'lib/comet/models/constellation_role_options.rb', line 82

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



70
71
72
73
74
75
76
77
78
79
# File 'lib/comet/models/constellation_role_options.rb', line 70

def to_hash
  ret = {}
  ret['RoleEnabled'] = @role_enabled
  ret['DeleteUnusedData'] = @delete_unused_data
  ret['Servers'] = @servers
  @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



87
88
89
# File 'lib/comet/models/constellation_role_options.rb', line 87

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