class Comet::BackupJobProgress

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

Attributes

bytes_done[RW]

@type [Number] bytes_done

counter[RW]

@type [Number] counter

items_done[RW]

@type [Number] items_done

recieved_time[RW]

@type [Number] recieved_time

sent_time[RW]

@type [Number] sent_time

unknown_json_fields[RW]

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

Public Class Methods

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

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/backup_job_progress.rb, line 39
def clear
  @counter = 0
  @sent_time = 0
  @recieved_time = 0
  @bytes_done = 0
  @items_done = 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_progress.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 'Counter'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

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

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

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

      @items_done = 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_progress.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_progress.rb, line 102
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_progress.rb, line 88
def to_hash
  ret = {}
  ret['Counter'] = @counter
  ret['SentTime'] = @sent_time
  ret['RecievedTime'] = @recieved_time
  ret['BytesDone'] = @bytes_done
  ret['ItemsDone'] = @items_done
  @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_progress.rb, line 107
def to_json(options = {})
  to_hash.to_json(options)
end