-
Notifications
You must be signed in to change notification settings - Fork 22
/
consumer_list_response.json
381 lines (381 loc) · 12.5 KB
/
consumer_list_response.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
81
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://nats.io/schemas/jetstream/api/v1/consumer_list_response.json",
"description": "A response from the JetStream $JS.API.CONSUMER.LIST API",
"title": "io.nats.jetstream.api.v1.consumer_list_response",
"type": "object",
"required": [
"type"
],
"allOf": [
{
"type": "object",
"required": [
"total",
"offset",
"limit"
],
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"offset": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 0
}
}
}
],
"oneOf": [
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "integer",
"description": "HTTP like error code in the 300 to 500 range",
"minimum": 300,
"maximum": 699
},
"description": {
"type": "string",
"description": "A human friendly description of the error"
},
"err_code": {
"type": "integer",
"description": "The NATS error code unique to each kind of error",
"minimum": 0,
"maximum": 65535
}
}
}
}
},
{
"type": "object",
"required": [
"consumers"
],
"properties": {
"consumer": {
"required": [
"stream_name",
"name",
"config",
"created",
"delivered",
"ack_floor",
"num_ack_pending",
"num_redelivered",
"num_waiting",
"num_pending"
],
"type": "object",
"properties": {
"stream_name": {
"type": "string",
"description": "The Stream the consumer belongs to"
},
"name": {
"type": "string",
"description": "A unique name for the consumer, either machine generated or the durable name"
},
"config": {
"required": [
"deliver_policy",
"ack_policy",
"replay_policy"
],
"allOf": [
{
"oneOf": [
{
"required": [
"deliver_policy"
],
"properties": {
"deliver_policy": {
"type": "string",
"enum": [
"all"
]
}
}
},
{
"required": [
"deliver_policy"
],
"properties": {
"deliver_policy": {
"type": "string",
"enum": [
"last"
]
}
}
},
{
"required": [
"deliver_policy"
],
"properties": {
"deliver_policy": {
"type": "string",
"enum": [
"new"
]
}
}
},
{
"required": [
"deliver_policy",
"opt_start_seq"
],
"properties": {
"deliver_policy": {
"type": "string",
"enum": [
"by_start_sequence"
]
},
"opt_start_seq": {
"type": "integer",
"minimum": 0
}
}
},
{
"required": [
"deliver_policy",
"opt_start_time"
],
"properties": {
"deliver_policy": {
"type": "string",
"enum": [
"by_start_time"
]
},
"opt_start_time": {
"type": "string"
}
}
}
]
}
],
"properties": {
"durable_name": {
"description": "A unique name for a durable consumer",
"type": "string",
"pattern": "^[^.*>]+$",
"minLength": 1
},
"deliver_subject": {
"type": "string",
"minLength": 1
},
"ack_policy": {
"type": "string",
"enum": [
"none",
"all",
"explicit"
]
},
"ack_wait": {
"description": "How long (in nanoseconds) to allow messages to remain un-acknowledged before attempting redelivery",
"type": "integer",
"minimum": 1
},
"max_deliver": {
"type": "integer",
"description": "The number of times a message will be redelivered to consumers if not acknowledged in time"
},
"filter_subject": {
"type": "string"
},
"replay_policy": {
"type": "string",
"enum": [
"instant",
"original"
]
},
"sample_freq": {
"type": "string"
},
"rate_limit_bps": {
"type": "integer",
"description": "The rate at which messages will be delivered to clients, expressed in bit per second",
"minimum": 0
},
"max_ack_pending": {
"type": "integer",
"description": "The maximum number of messages without acknowledgement that can be outstanding, once this limit is reached message delivery will be suspended"
},
"idle_heartbeat": {
"type": "integer",
"minimum": 0,
"description": "If the Consumer is idle for more than this many nano seconds a empty message with Status header 100 will be sent indicating the consumer is still alive"
},
"flow_control": {
"type": "boolean",
"description": "For push consumers this will regularly send an empty mess with Status header 100 and a reply subject, consumers must reply to these messages to control the rate of message delivery"
},
"max_waiting": {
"type": "integer",
"description": "The number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored",
"minimum": 0,
"default": 512
},
"direct": {
"type": "boolean",
"description": "Creates a special consumer that does not touch the Raft layers, not for general use by clients, internal use only",
"default": false
}
}
},
"created": {
"type": "string"
},
"delivered": {
"description": "The last message delivered from this Consumer",
"type": "object",
"additionalProperties": false,
"required": [
"consumer_seq",
"stream_seq"
],
"properties": {
"consumer_seq": {
"type": "integer",
"description": "The sequence number of the Consumer",
"minimum": 0
},
"stream_seq": {
"type": "integer",
"description": "The sequence number of the Stream",
"minimum": 0
}
}
},
"ack_floor": {
"description": "The highest contiguous acknowledged message",
"type": "object",
"additionalProperties": false,
"required": [
"consumer_seq",
"stream_seq"
],
"properties": {
"consumer_seq": {
"type": "integer",
"description": "The sequence number of the Consumer",
"minimum": 0
},
"stream_seq": {
"type": "integer",
"description": "The sequence number of the Stream",
"minimum": 0
}
}
},
"num_ack_pending": {
"description": "The number of messages pending acknowledgement",
"type": "integer",
"minimum": 0
},
"num_redelivered": {
"description": "The number of redeliveries that have been performed",
"type": "integer",
"minimum": 0
},
"num_waiting": {
"description": "The number of pull consumers waiting for messages",
"type": "integer",
"minimum": 0
},
"num_pending": {
"description": "The number of messages left unconsumed in this Consumer",
"type": "integer",
"minimum": 0
},
"cluster": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The cluster name"
},
"leader": {
"type": "string",
"description": "The server name of the RAFT leader"
},
"replicas": {
"type": "array",
"description": "The members of the RAFT cluster",
"items": {
"type": "object",
"required": [
"name",
"current",
"active"
],
"properties": {
"name": {
"description": "The server name of the peer",
"type": "string",
"minimum": 1
},
"current": {
"description": "Indicates if the server is up to date and synchronised",
"type": "boolean",
"default": false
},
"active": {
"description": "Nanoseconds since this peer was last seen",
"type": "number"
},
"offline": {
"description": "Indicates the node is considered offline by the group",
"type": "boolean",
"default": false
},
"lag": {
"description": "How many uncommitted operations this peer is behind the leader",
"type": "integer",
"minimum": 0
}
}
}
}
}
}
}
}
}
}
],
"properties": {
"type": {
"type": "string",
"const": "io.nats.jetstream.api.v1.consumer_list_response"
}
}
}