Class: Comet::UninstallConfig

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeUninstallConfig

Returns a new instance of UninstallConfig.



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

def initialize
  clear
end

Instance Attribute Details

#remove_config_fileObject

Returns the value of attribute remove_config_file.



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

def remove_config_file
  @remove_config_file
end

#uninstall_flagObject

Returns the value of attribute uninstall_flag.



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

def uninstall_flag
  @uninstall_flag
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



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

def clear
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/comet/models/uninstall_config.rb', line 40

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 'UninstallFlag'
      @uninstall_flag = v
    when 'RemoveConfigFile'
      @remove_config_file = 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)


33
34
35
36
37
# File 'lib/comet/models/uninstall_config.rb', line 33

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



67
68
69
# File 'lib/comet/models/uninstall_config.rb', line 67

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



56
57
58
59
60
61
62
63
64
# File 'lib/comet/models/uninstall_config.rb', line 56

def to_hash
  ret = {}
  ret['UninstallFlag'] = @uninstall_flag
  ret['RemoveConfigFile'] = @remove_config_file
  @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



72
73
74
# File 'lib/comet/models/uninstall_config.rb', line 72

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