Class: Comet::BackupJobAdvancedOptions

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

Overview

specified as part of a schedule in the BackupRuleConfig type, or supplied immediately when running a job.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BackupJobAdvancedOptions

Returns a new instance of BackupJobAdvancedOptions.



48
49
50
 
# File 'lib/comet/models/backup_job_advanced_options.rb', line 48

def initialize
  clear
end

Instance Attribute Details

#allow_zero_files_success ⇒ Object

Default disabled



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

def allow_zero_files_success
  @allow_zero_files_success
end

#auto_retention_level ⇒ Object

If Zero: default Automatic (BACKUPJOBAUTORETENTION_AUTOMATIC)



43
44
45
 
# File 'lib/comet/models/backup_job_advanced_options.rb', line 43

def auto_retention_level
  @auto_retention_level
end

#limit_vault_speed_bps ⇒ Object

If Zero: disabled



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

def limit_vault_speed_bps
  @limit_vault_speed_bps
end

#reduce_disk_concurrency ⇒ Object

Default disabled



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

def reduce_disk_concurrency
  @reduce_disk_concurrency
end

#skip_already_running ⇒ Object

Returns the value of attribute skip_already_running.



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

def skip_already_running
  @skip_already_running
end

#stop_after ⇒ Object

If Zero: disabled



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

def stop_after
  @stop_after
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



46
47
48
 
# File 'lib/comet/models/backup_job_advanced_options.rb', line 46

def unknown_json_fields
  @unknown_json_fields
end

#use_on_disk_indexes ⇒ Object

Default disabled



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

def use_on_disk_indexes
  @use_on_disk_indexes
end

Instance Method Details

#clear ⇒ Object 



52
53
54
55
56
57
 
# File 'lib/comet/models/backup_job_advanced_options.rb', line 52

def clear
  @stop_after = 0
  @limit_vault_speed_bps = 0
  @auto_retention_level = 0
  @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
 
# File 'lib/comet/models/backup_job_advanced_options.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 'SkipAlreadyRunning'
      @skip_already_running = v
    when 'StopAfter'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

      @limit_vault_speed_bps = v
    when 'ReduceDiskConcurrency'
      @reduce_disk_concurrency = v
    when 'UseOnDiskIndexes'
      @use_on_disk_indexes = v
    when 'AllowZeroFilesSuccess'
      @allow_zero_files_success = v
    when 'AutoRetentionLevel'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @auto_retention_level = 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/backup_job_advanced_options.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_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



115
116
117
 
# File 'lib/comet/models/backup_job_advanced_options.rb', line 115

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/comet/models/backup_job_advanced_options.rb', line 99

def to_hash
  ret = {}
  ret['SkipAlreadyRunning'] = @skip_already_running
  ret['StopAfter'] = @stop_after
  ret['LimitVaultSpeedBps'] = @limit_vault_speed_bps
  ret['ReduceDiskConcurrency'] = @reduce_disk_concurrency
  ret['UseOnDiskIndexes'] = @use_on_disk_indexes
  ret['AllowZeroFilesSuccess'] = @allow_zero_files_success
  ret['AutoRetentionLevel'] = @auto_retention_level
  @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



120
121
122
 
# File 'lib/comet/models/backup_job_advanced_options.rb', line 120

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