Class: Comet::VMInfo

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

Overview

VMInfo is a typed class wrapper around the underlying Comet Server API data structure. This type is available in Comet 24.12.x and later.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ VMInfo

Returns a new instance of VMInfo.



43
44
45
 
# File 'lib/comet/models/vminfo.rb', line 43

def initialize
  clear
end

Instance Attribute Details

#config_path ⇒ Object

Relative path to config file or directory, if supported by this Protected Item type



35
36
37
 
# File 'lib/comet/models/vminfo.rb', line 35

def config_path
  @config_path
end

#cpucores ⇒ Object

Returns the value of attribute cpucores.



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

def cpucores
  @cpucores
end

#disks ⇒ Object

Returns the value of attribute disks.



38
39
40
 
# File 'lib/comet/models/vminfo.rb', line 38

def disks
  @disks
end

#firmware_type ⇒ Object

The BIOS mode of this machine e.g. “Legacy”|“UEFI”



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

def firmware_type
  @firmware_type
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/comet/models/vminfo.rb', line 17

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



20
21
22
 
# File 'lib/comet/models/vminfo.rb', line 20

def name
  @name
end

#ram_bytes ⇒ Object

Bytes



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

def ram_bytes
  @ram_bytes
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/comet/models/vminfo.rb', line 47

def clear
  @id = ''
  @name = ''
  @cpucores = 0
  @ram_bytes = 0
  @firmware_type = ''
  @config_path = ''
  @disks = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
102
103
104
105
106
107
108
109
 
# File 'lib/comet/models/vminfo.rb', line 66

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 'ID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

      @name = v
    when 'CPUCores'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @cpucores = v
    when 'RamBytes'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

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

      @config_path = v
    when 'Disks'
      if v.nil?
        @disks = []
      else
        @disks = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @disks[i1] = Comet::VMDiskInfo.new
          @disks[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) 


59
60
61
62
63
 
# File 'lib/comet/models/vminfo.rb', line 59

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



128
129
130
 
# File 'lib/comet/models/vminfo.rb', line 128

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/comet/models/vminfo.rb', line 112

def to_hash
  ret = {}
  ret['ID'] = @id
  ret['Name'] = @name
  ret['CPUCores'] = @cpucores
  ret['RamBytes'] = @ram_bytes
  ret['FirmwareType'] = @firmware_type
  ret['ConfigPath'] = @config_path
  ret['Disks'] = @disks
  @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



133
134
135
 
# File 'lib/comet/models/vminfo.rb', line 133

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