Class: Comet::PVEParams

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

Overview

This type is available in Comet 25.8.0 and later.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PVEParams

Returns a new instance of PVEParams.



41
42
43
 
# File 'lib/comet/models/pveparams.rb', line 41

def initialize
  clear
end

Instance Attribute Details

#everything ⇒ Object

Returns the value of attribute everything.



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

def everything
  @everything
end

#exclusions ⇒ Object

Returns the value of attribute exclusions.



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

def exclusions
  @exclusions
end

#method ⇒ Object

One of the PVE_BACKUP_METHOD constants



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

def method
  @method
end

#selections ⇒ Object

Returns the value of attribute selections.



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

def selections
  @selections
end

#sshconnection ⇒ Object

Primary node URL + SSH credentials



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

def sshconnection
  @sshconnection
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#use_cbt ⇒ Object

Returns the value of attribute use_cbt.



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

def use_cbt
  @use_cbt
end

Instance Method Details

#clear ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/comet/models/pveparams.rb', line 45

def clear
  @exclusions = []
  @method = ''
  @sshconnection = Comet::SSHConnection.new
  @selections = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


61
62
63
64
65
66
67
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
 
# File 'lib/comet/models/pveparams.rb', line 61

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 'Everything'
      @everything = v
    when 'Exclusions'
      if v.nil?
        @exclusions = []
      else
        @exclusions = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @exclusions[i1] = Comet::PVEBackupNode.new
          @exclusions[i1].from_hash(v1)
        end
      end
    when 'Method'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @method = v
    when 'SSHConnection'
      @sshconnection = Comet::SSHConnection.new
      @sshconnection.from_hash(v)
    when 'Selections'
      if v.nil?
        @selections = []
      else
        @selections = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @selections[i1] = Comet::PVEBackupNode.new
          @selections[i1].from_hash(v1)
        end
      end
    when 'UseCBT'
      @use_cbt = 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) 


54
55
56
57
58
 
# File 'lib/comet/models/pveparams.rb', line 54

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



131
132
133
 
# File 'lib/comet/models/pveparams.rb', line 131

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/comet/models/pveparams.rb', line 104

def to_hash
  ret = {}
  unless @everything.nil?
    ret['Everything'] = @everything
  end
  unless @exclusions.nil?
    ret['Exclusions'] = @exclusions
  end
  unless @method.nil?
    ret['Method'] = @method
  end
  unless @sshconnection.nil?
    ret['SSHConnection'] = @sshconnection
  end
  unless @selections.nil?
    ret['Selections'] = @selections
  end
  unless @use_cbt.nil?
    ret['UseCBT'] = @use_cbt
  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



136
137
138
 
# File 'lib/comet/models/pveparams.rb', line 136

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