Class: Comet::ReplicatorStateAPIResponse

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ReplicatorStateAPIResponse

Returns a new instance of ReplicatorStateAPIResponse.



54
55
56
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 54

def initialize
  clear
end

Instance Attribute Details

#active_workers ⇒ Object

Returns the value of attribute active_workers.



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

def active_workers
  @active_workers
end

#bytes_queued ⇒ Object

Returns the value of attribute bytes_queued.



37
38
39
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 37

def bytes_queued
  @bytes_queued
end

#bytes_replicated ⇒ Object

Returns the value of attribute bytes_replicated.



49
50
51
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 49

def bytes_replicated
  @bytes_replicated
end

#current_time ⇒ Object

Returns the value of attribute current_time.



43
44
45
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 43

def current_time
  @current_time
end

#description ⇒ Object

Returns the value of attribute description.



16
17
18
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 16

def description
  @description
end

#display_class ⇒ Object

Returns the value of attribute display_class.



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

def display_class
  @display_class
end

#items_queued ⇒ Object

Returns the value of attribute items_queued.



34
35
36
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 34

def items_queued
  @items_queued
end

#items_replicated ⇒ Object

Returns the value of attribute items_replicated.



46
47
48
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 46

def items_replicated
  @items_replicated
end

#last_worker_submit_time ⇒ Object

Returns the value of attribute last_worker_submit_time.



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

def last_worker_submit_time
  @last_worker_submit_time
end

#remote_server_id ⇒ Object

Returns the value of attribute remote_server_id.



19
20
21
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 19

def remote_server_id
  @remote_server_id
end

#state ⇒ Object

Returns the value of attribute state.



31
32
33
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 31

def state
  @state
end

#total_workers ⇒ Object

Returns the value of attribute total_workers.



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

def total_workers
  @total_workers
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



52
53
54
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 52

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 58

def clear
  @description = ''
  @remote_server_id = ''
  @display_class = 0
  @active_workers = 0
  @total_workers = 0
  @state = 0
  @items_queued = 0
  @bytes_queued = 0
  @last_worker_submit_time = 0
  @current_time = 0
  @items_replicated = 0
  @bytes_replicated = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 82

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

      @description = v
    when 'RemoteServerID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

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

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

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

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

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

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

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

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


75
76
77
78
79
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 75

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



163
164
165
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 163

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 142

def to_hash
  ret = {}
  ret['Description'] = @description
  ret['RemoteServerID'] = @remote_server_id
  ret['DisplayClass'] = @display_class
  ret['ActiveWorkers'] = @active_workers
  ret['TotalWorkers'] = @total_workers
  ret['State'] = @state
  ret['ItemsQueued'] = @items_queued
  ret['BytesQueued'] = @bytes_queued
  ret['LastWorkerSubmitTime'] = @last_worker_submit_time
  ret['CurrentTime'] = @current_time
  ret['ItemsReplicated'] = @items_replicated
  ret['BytesReplicated'] = @bytes_replicated
  @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



168
169
170
 
# File 'lib/comet/models/replicator_state_apiresponse.rb', line 168

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