lib/comet/models/backup_job_progress.rb



# frozen_string_literal: true

# Copyright (c) 2020-2024 Comet Licensing Ltd.
# Please see the LICENSE file for usage information.
#
# SPDX-License-Identifier: MIT

require 'json'

module Comet

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

    # This field will always increase monotonically, exactly once, for every change to the
    # BackupJobProgress for a given backup job.
    # @type [Number] counter
    attr_accessor :counter

    # Unix timestamp in seconds
    # @type [Number] sent_time
    attr_accessor :sent_time

    # Unix timestamp in seconds. The typo is preserved for backwards-compatibility reasons.
    # @type [Number] recieved_time
    attr_accessor :recieved_time

    # @type [Number] bytes_done
    attr_accessor :bytes_done

    # @type [Number] items_done
    attr_accessor :items_done

    # @type [Number] items_total
    attr_accessor :items_total

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

    def initialize
      clear
    end

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

    # @param [String] json_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

    # @param [Hash] obj 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
        when 'ItemsTotal'
          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

          @items_total = v
        else
          @unknown_json_fields[k] = v
        end
      end
    end

    # @return [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
      ret['ItemsTotal'] = @items_total
      @unknown_json_fields.each do |k, v|
        ret[k] = v
      end
      ret
    end

    # @return [Hash] The complete object as a Ruby hash
    def to_h
      to_hash
    end

    # @return [String] The complete object as a JSON string
    def to_json(options = {})
      to_hash.to_json(options)
    end
  end
end