class Comet::BackupRuleConfig

BackupRuleConfig 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

create_time[RW]

@type [Number] create_time

description[RW]

@type [String] description

destination[RW]

@type [String] destination

event_triggers[RW]

@type [Comet::BackupRuleEventTriggers] event_triggers

limit_vault_speed_bps[RW]

@type [Number] limit_vault_speed_bps

modify_time[RW]

@type [Number] modify_time

post_exec[RW]

@type [Array<String>] post_exec

pre_exec[RW]

@type [Array<String>] pre_exec

reduce_disk_concurrency[RW]

@type [Boolean] reduce_disk_concurrency

schedules[RW]

@type [Array<Comet::ScheduleConfig>] schedules

skip_already_running[RW]

@type [Boolean] skip_already_running

source[RW]

@type [String] source

stop_after[RW]

@type [Number] stop_after

thaw_exec[RW]

@type [Array<String>] thaw_exec

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_rule_config.rb, line 68
def initialize
  clear
end

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/backup_rule_config.rb, line 72
def clear
  @description = ''
  @create_time = 0
  @modify_time = 0
  @pre_exec = []
  @thaw_exec = []
  @post_exec = []
  @source = ''
  @destination = ''
  @stop_after = 0
  @limit_vault_speed_bps = 0
  @schedules = []
  @event_triggers = Comet::BackupRuleEventTriggers.new
  @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_rule_config.rb, line 96
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 'Description'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

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

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

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

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

      @destination = v
    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 'Schedules'
      if v.nil?
        @schedules = []
      else
        @schedules = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @schedules[i1] = Comet::ScheduleConfig.new
          @schedules[i1].from_hash(v1)
        end
      end
    when 'EventTriggers'
      @event_triggers = Comet::BackupRuleEventTriggers.new
      @event_triggers.from_hash(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_rule_config.rb, line 89
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_rule_config.rb, line 215
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_rule_config.rb, line 190
def to_hash
  ret = {}
  ret['Description'] = @description
  ret['CreateTime'] = @create_time
  ret['ModifyTime'] = @modify_time
  ret['PreExec'] = @pre_exec
  ret['ThawExec'] = @thaw_exec
  ret['PostExec'] = @post_exec
  ret['Source'] = @source
  ret['Destination'] = @destination
  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['Schedules'] = @schedules
  ret['EventTriggers'] = @event_triggers
  @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_rule_config.rb, line 220
def to_json(options = {})
  to_hash.to_json(options)
end