class Comet::BackupJobProgress

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

def clear

def clear
  @counter = 0
  @sent_time = 0
  @recieved_time = 0
  @bytes_done = 0
  @items_done = 0
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • obj (Hash) -- The complete object as a Ruby hash
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

def from_json(json_string)

Parameters:
  • json_string (String) -- The complete object in JSON format
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

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
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

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end