Class: Comet::VaultSnapshot

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ VaultSnapshot

Returns a new instance of VaultSnapshot.



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

def initialize
  clear
end

Instance Attribute Details

#create_time ⇒ Object

Returns the value of attribute create_time.



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

def create_time
  @create_time
end

#engine_type ⇒ Object

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



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

def engine_type
  @engine_type
end

#has_original_path_info ⇒ Object

This field is available in Comet 20.12.4 and later.



30
31
32
 
# File 'lib/comet/models/vault_snapshot.rb', line 30

def has_original_path_info
  @has_original_path_info
end

#snapshot ⇒ Object

Returns the value of attribute snapshot.



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

def snapshot
  @snapshot
end

#source ⇒ Object

Returns the value of attribute source.



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

def source
  @source
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/comet/models/vault_snapshot.rb', line 39

def clear
  @snapshot = ''
  @engine_type = ''
  @source = ''
  @create_time = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
 
# File 'lib/comet/models/vault_snapshot.rb', line 55

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

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

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

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

      @create_time = v
    when 'HasOriginalPathInfo'
      @has_original_path_info = 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) 


48
49
50
51
52
 
# File 'lib/comet/models/vault_snapshot.rb', line 48

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



99
100
101
 
# File 'lib/comet/models/vault_snapshot.rb', line 99

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



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/comet/models/vault_snapshot.rb', line 85

def to_hash
  ret = {}
  ret['Snapshot'] = @snapshot
  ret['EngineType'] = @engine_type
  ret['Source'] = @source
  ret['CreateTime'] = @create_time
  ret['HasOriginalPathInfo'] = @has_original_path_info
  @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



104
105
106
 
# File 'lib/comet/models/vault_snapshot.rb', line 104

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