Class: Comet::ConstellationStats

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConstellationStats

Returns a new instance of ConstellationStats.



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

def initialize
  clear
end

Instance Attribute Details

#checks_currently_active ⇒ Object

Returns the value of attribute checks_currently_active.



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

def checks_currently_active
  @checks_currently_active
end

#last_check_start ⇒ Object

Unix timestamp, in seconds.



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

def last_check_start
  @last_check_start
end

#total_buckets_deleted ⇒ Object

The total number of buckets that Constellation has successfully deleted since this Comet Server was last restarted



27
28
29
 
# File 'lib/comet/models/constellation_stats.rb', line 27

def total_buckets_deleted
  @total_buckets_deleted
end

#total_checks_started ⇒ Object

The total number of Constellation bucket report scans that have been performed since this Comet Server was last restarted



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

def total_checks_started
  @total_checks_started
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



33
34
35
 
# File 'lib/comet/models/constellation_stats.rb', line 33

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/comet/models/constellation_stats.rb', line 39

def clear
  @last_check_start = 0
  @total_checks_started = 0
  @total_buckets_deleted = 0
  @checks_currently_active = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/comet/models/constellation_stats.rb', line 55

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

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

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

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

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


48
49
50
51
52
 
# File 'lib/comet/models/constellation_stats.rb', line 48

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



96
97
98
 
# File 'lib/comet/models/constellation_stats.rb', line 96

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



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/comet/models/constellation_stats.rb', line 83

def to_hash
  ret = {}
  ret['LastCheckStart'] = @last_check_start
  ret['TotalChecksStarted'] = @total_checks_started
  ret['TotalBucketsDeleted'] = @total_buckets_deleted
  ret['ChecksCurrentlyActive'] = @checks_currently_active
  @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



101
102
103
 
# File 'lib/comet/models/constellation_stats.rb', line 101

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