Class: Comet::RestoreJobAdvancedOptions

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RestoreJobAdvancedOptions

Returns a new instance of RestoreJobAdvancedOptions.



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

def initialize
  clear
end

Instance Attribute Details

#archive_format ⇒ Object

Returns the value of attribute archive_format.



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

def archive_format
  @archive_format
end

#dest_is_original_location ⇒ Object

Returns the value of attribute dest_is_original_location.



24
25
26
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 24

def dest_is_original_location
  @dest_is_original_location
end

#dest_path ⇒ Object

Returns the value of attribute dest_path.



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

def dest_path
  @dest_path
end

#exact_dest_paths ⇒ Object

Returns the value of attribute exact_dest_paths.



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

def exact_dest_paths
  @exact_dest_paths
end

#overwrite_existing_files ⇒ Object

Returns the value of attribute overwrite_existing_files.



21
22
23
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 21

def overwrite_existing_files
  @overwrite_existing_files
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



36
37
38
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 36

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 42

def clear
  @type = 0
  @dest_path = ''
  @exact_dest_paths = []
  @archive_format = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 58

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

      @type = v
    when 'OverwriteExistingFiles'
      @overwrite_existing_files = v
    when 'DestIsOriginalLocation'
      @dest_is_original_location = v
    when 'DestPath'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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


51
52
53
54
55
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 51

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



112
113
114
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 112

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



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 97

def to_hash
  ret = {}
  ret['Type'] = @type
  ret['OverwriteExistingFiles'] = @overwrite_existing_files
  ret['DestIsOriginalLocation'] = @dest_is_original_location
  ret['DestPath'] = @dest_path
  ret['ExactDestPaths'] = @exact_dest_paths
  ret['ArchiveFormat'] = @archive_format
  @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



117
118
119
 
# File 'lib/comet/models/restore_job_advanced_options.rb', line 117

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