Class: Comet::VMDKSnapshotViewOptions

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeVMDKSnapshotViewOptions

Returns a new instance of VMDKSnapshotViewOptions.



34
35
36
# File 'lib/comet/models/vmdksnapshot_view_options.rb', line 34

def initialize
  clear
end

Instance Attribute Details

#enabledObject

Request a list of stored objects in vmdk file. It should be always true for restoring single files from vmdk file



18
19
20
# File 'lib/comet/models/vmdksnapshot_view_options.rb', line 18

def enabled
  @enabled
end

#list_pathObject

Browse objects’ paths inside vmdk file



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

def list_path
  @list_path
end

#partition_guidObject

The vmdk filename inside subdirectory of disk image, should be end with .vmdk



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

def partition_guid
  @partition_guid
end

#partition_nameObject

Returns the value of attribute partition_name.



29
30
31
# File 'lib/comet/models/vmdksnapshot_view_options.rb', line 29

def partition_name
  @partition_name
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



32
33
34
# File 'lib/comet/models/vmdksnapshot_view_options.rb', line 32

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



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

def clear
  @partition_guid = ''
  @list_path = ''
  @partition_name = ''
  @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
# File 'lib/comet/models/vmdksnapshot_view_options.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 'Enabled'
      @enabled = v
    when 'PartitionGUID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

      @partition_name = 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/vmdksnapshot_view_options.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_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



92
93
94
# File 'lib/comet/models/vmdksnapshot_view_options.rb', line 92

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



79
80
81
82
83
84
85
86
87
88
89
# File 'lib/comet/models/vmdksnapshot_view_options.rb', line 79

def to_hash
  ret = {}
  ret['Enabled'] = @enabled
  ret['PartitionGUID'] = @partition_guid
  ret['ListPath'] = @list_path
  ret['PartitionName'] = @partition_name
  @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



97
98
99
# File 'lib/comet/models/vmdksnapshot_view_options.rb', line 97

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