class Comet::BackupJobAdvancedOptions

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

Attributes

allow_zero_files_success[RW]

@type [Boolean] allow_zero_files_success

limit_vault_speed_bps[RW]

@type [Number] limit_vault_speed_bps

reduce_disk_concurrency[RW]

@type [Boolean] reduce_disk_concurrency

skip_already_running[RW]

@type [Boolean] skip_already_running

stop_after[RW]

@type [Number] stop_after

unknown_json_fields[RW]

@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations

use_on_disk_indexes[RW]

@type [Boolean] use_on_disk_indexes

Public Class Methods

new() click to toggle source
# File lib/comet/models/backup_job_advanced_options.rb, line 38
def initialize
  clear
end

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/backup_job_advanced_options.rb, line 42
def clear
  @stop_after = 0
  @limit_vault_speed_bps = 0
  @unknown_json_fields = {}
end
from_hash(obj) click to toggle source

@param [Hash] obj The complete object as a Ruby hash

# File lib/comet/models/backup_job_advanced_options.rb, line 56
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
    else
      @unknown_json_fields[k] = v
    end
  end
end
from_json(json_string) click to toggle source

@param [String] json_string The complete object in JSON format

# File lib/comet/models/backup_job_advanced_options.rb, line 49
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() click to toggle source

@return [Hash] The complete object as a Ruby hash

# File lib/comet/models/backup_job_advanced_options.rb, line 99
def to_h
  to_hash
end
to_hash() click to toggle source

@return [Hash] The complete object as a Ruby hash

# File lib/comet/models/backup_job_advanced_options.rb, line 84
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
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end
to_json(options = {}) click to toggle source

@return [String] The complete object as a JSON string

# File lib/comet/models/backup_job_advanced_options.rb, line 104
def to_json(options = {})
  to_hash.to_json(options)
end