Class: Comet::BackupJobProgress

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/backup_job_progress.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BackupJobProgress

Returns a new instance of BackupJobProgress.



40
41
42
 
# File 'lib/comet/models/backup_job_progress.rb', line 40

def initialize
  clear
end

Instance Attribute Details

#bytes_done ⇒ Object

Returns the value of attribute bytes_done.



29
30
31
 
# File 'lib/comet/models/backup_job_progress.rb', line 29

def bytes_done
  @bytes_done
end

#counter ⇒ Object

This field will always increase monotonically, exactly once, for every change to the BackupJobProgress for a given backup job.



18
19
20
 
# File 'lib/comet/models/backup_job_progress.rb', line 18

def counter
  @counter
end

#items_done ⇒ Object

Returns the value of attribute items_done.



32
33
34
 
# File 'lib/comet/models/backup_job_progress.rb', line 32

def items_done
  @items_done
end

#items_total ⇒ Object

Returns the value of attribute items_total.



35
36
37
 
# File 'lib/comet/models/backup_job_progress.rb', line 35

def items_total
  @items_total
end

#recieved_time ⇒ Object

Unix timestamp in seconds. The typo is preserved for backwards-compatibility reasons.



26
27
28
 
# File 'lib/comet/models/backup_job_progress.rb', line 26

def recieved_time
  @recieved_time
end

#sent_time ⇒ Object

Unix timestamp in seconds



22
23
24
 
# File 'lib/comet/models/backup_job_progress.rb', line 22

def sent_time
  @sent_time
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



38
39
40
 
# File 'lib/comet/models/backup_job_progress.rb', line 38

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/comet/models/backup_job_progress.rb', line 44

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

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/comet/models/backup_job_progress.rb', line 62

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

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


55
56
57
58
59
 
# File 'lib/comet/models/backup_job_progress.rb', line 55

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 ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



113
114
115
 
# File 'lib/comet/models/backup_job_progress.rb', line 113

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/comet/models/backup_job_progress.rb', line 98

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

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



118
119
120
 
# File 'lib/comet/models/backup_job_progress.rb', line 118

def to_json(options = {})
  to_hash.to_json(options)
end