Class: Comet::PVEBackupVM

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PVEBackupVM

Returns a new instance of PVEBackupVM.



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

def initialize
  clear
end

Instance Attribute Details

#included_disks ⇒ Object

Returns the value of attribute included_disks.



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

def included_disks
  @included_disks
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#selected ⇒ Object

Returns the value of attribute selected.



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

def selected
  @selected
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#vmid ⇒ Object

Returns the value of attribute vmid.



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

def vmid
  @vmid
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @included_disks = []
  @name = ''
  @type = ''
  @vmid = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
85
86
 
# File 'lib/comet/models/pvebackup_vm.rb', line 53

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

      @name = v
    when 'Selected'
      @selected = v
    when 'Type'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @type = v
    when 'VMID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @vmid = 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) 


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

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



113
114
115
 
# File 'lib/comet/models/pvebackup_vm.rb', line 113

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/comet/models/pvebackup_vm.rb', line 89

def to_hash
  ret = {}
  unless @included_disks.nil?
    ret['IncludedDisks'] = @included_disks
  end
  unless @name.nil?
    ret['Name'] = @name
  end
  unless @selected.nil?
    ret['Selected'] = @selected
  end
  unless @type.nil?
    ret['Type'] = @type
  end
  unless @vmid.nil?
    ret['VMID'] = @vmid
  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



118
119
120
 
# File 'lib/comet/models/pvebackup_vm.rb', line 118

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