Class: Comet::HyperVMachineInfo

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeHyperVMachineInfo

Returns a new instance of HyperVMachineInfo.



44
45
46
# File 'lib/comet/models/hyper_vmachine_info.rb', line 44

def initialize
  clear
end

Instance Attribute Details

#config_file_pathObject

This field is available in Comet 24.12.x and later.



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

def config_file_path
  @config_file_path
end

#cpucoresObject

This field is available in Comet 24.12.x and later.



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

def cpucores
  @cpucores
end

#display_nameObject

Returns the value of attribute display_name.



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

def display_name
  @display_name
end

#generationObject

This field is available in Comet 24.12.x and later.



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

def generation
  @generation
end

#hard_drivesObject

This field is available in Comet 24.12.x and later.



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

def hard_drives
  @hard_drives
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#memory_limit_mbObject

This field is available in Comet 24.12.x and later.



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

def memory_limit_mb
  @memory_limit_mb
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



42
43
44
# File 'lib/comet/models/hyper_vmachine_info.rb', line 42

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



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

def clear
  @id = ''
  @display_name = ''
  @memory_limit_mb = 0
  @cpucores = 0
  @hard_drives = []
  @generation = 0
  @config_file_path = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


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
110
111
# File 'lib/comet/models/hyper_vmachine_info.rb', line 67

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

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

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

      @cpucores = v
    when 'HardDrives'
      if v.nil?
        @hard_drives = []
      else
        @hard_drives = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @hard_drives[i1] = v1
        end
      end
    when 'Generation'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

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


60
61
62
63
64
# File 'lib/comet/models/hyper_vmachine_info.rb', line 60

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



130
131
132
# File 'lib/comet/models/hyper_vmachine_info.rb', line 130

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/comet/models/hyper_vmachine_info.rb', line 114

def to_hash
  ret = {}
  ret['ID'] = @id
  ret['Name'] = @display_name
  ret['MemoryLimitMB'] = @memory_limit_mb
  ret['CPUCores'] = @cpucores
  ret['HardDrives'] = @hard_drives
  ret['Generation'] = @generation
  ret['ConfigFilePath'] = @config_file_path
  @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



135
136
137
# File 'lib/comet/models/hyper_vmachine_info.rb', line 135

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