Class: Comet::PVEStorageName

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

Overview

PVEStorageName is a typed class wrapper around the underlying Comet Server API data structure. PVEStorageName contains the name and type of storage configured on a Proxmox Cluster

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PVEStorageName

Returns a new instance of PVEStorageName.



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

def initialize
  clear
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



29
30
31
32
33
 
# File 'lib/comet/models/pvestorage_name.rb', line 29

def clear
  @name = ''
  @type = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/comet/models/pvestorage_name.rb', line 43

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

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

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


36
37
38
39
40
 
# File 'lib/comet/models/pvestorage_name.rb', line 36

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



74
75
76
 
# File 'lib/comet/models/pvestorage_name.rb', line 74

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



63
64
65
66
67
68
69
70
71
 
# File 'lib/comet/models/pvestorage_name.rb', line 63

def to_hash
  ret = {}
  ret['Name'] = @name
  ret['Type'] = @type
  @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



79
80
81
 
# File 'lib/comet/models/pvestorage_name.rb', line 79

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