Class: Comet::SizeMeasurement

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SizeMeasurement

Returns a new instance of SizeMeasurement.



30
31
32
 
# File 'lib/comet/models/size_measurement.rb', line 30

def initialize
  clear
end

Instance Attribute Details

#measure_completed ⇒ Object

Unix timestamp in seconds



25
26
27
 
# File 'lib/comet/models/size_measurement.rb', line 25

def measure_completed
  @measure_completed
end

#measure_started ⇒ Object

Unix timestamp in seconds



21
22
23
 
# File 'lib/comet/models/size_measurement.rb', line 21

def measure_started
  @measure_started
end

#size ⇒ Object

Bytes



17
18
19
 
# File 'lib/comet/models/size_measurement.rb', line 17

def size
  @size
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



28
29
30
 
# File 'lib/comet/models/size_measurement.rb', line 28

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



34
35
36
37
38
39
 
# File 'lib/comet/models/size_measurement.rb', line 34

def clear
  @size = 0
  @measure_started = 0
  @measure_completed = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/comet/models/size_measurement.rb', line 49

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 'Size'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

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

      @measure_completed = 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) 


42
43
44
45
46
 
# File 'lib/comet/models/size_measurement.rb', line 42

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



85
86
87
 
# File 'lib/comet/models/size_measurement.rb', line 85

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



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/comet/models/size_measurement.rb', line 73

def to_hash
  ret = {}
  ret['Size'] = @size
  ret['MeasureStarted'] = @measure_started
  ret['MeasureCompleted'] = @measure_completed
  @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



90
91
92
 
# File 'lib/comet/models/size_measurement.rb', line 90

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