-
Notifications
You must be signed in to change notification settings - Fork 0
/
protocol.txt
1636 lines (1465 loc) · 60.6 KB
/
protocol.txt
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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
This text file contains the kafka protocol messages that are not yet implemented.
Produce API (Key: 0):
*Requests:*
Produce Request (Version: 0) => acks timeout [topic_data]
acks => INT16
timeout => INT32
topic_data => topic [data]
topic => STRING
data => partition record_set
partition => INT32
record_set => RECORDS
Field Description
acks The number of acknowledgments the producer requires the leader to
have received before considering a request complete. Allowed values: 0
for no acknowledgments, 1 for only the leader and -1 for the full ISR.
timeout The time to await a response in ms.
topic_data null
topic Name of topic
data null
partition Topic partition id
record_set null
Produce Request (Version: 1) => acks timeout [topic_data]
acks => INT16
timeout => INT32
topic_data => topic [data]
topic => STRING
data => partition record_set
partition => INT32
record_set => RECORDS
Field Description
acks The number of acknowledgments the producer requires the leader to
have received before considering a request complete. Allowed values: 0
for no acknowledgments, 1 for only the leader and -1 for the full ISR.
timeout The time to await a response in ms.
topic_data null
topic Name of topic
data null
partition Topic partition id
record_set null
Produce Request (Version: 2) => acks timeout [topic_data]
acks => INT16
timeout => INT32
topic_data => topic [data]
topic => STRING
data => partition record_set
partition => INT32
record_set => RECORDS
Field Description
acks The number of acknowledgments the producer requires the leader to
have received before considering a request complete. Allowed values: 0
for no acknowledgments, 1 for only the leader and -1 for the full ISR.
timeout The time to await a response in ms.
topic_data null
topic Name of topic
data null
partition Topic partition id
record_set null
Produce Request (Version: 3) => transactional_id acks timeout [topic_data]
transactional_id => NULLABLE_STRING
acks => INT16
timeout => INT32
topic_data => topic [data]
topic => STRING
data => partition record_set
partition => INT32
record_set => RECORDS
Field Description
transactional_id The transactional id or null if the producer is not
transactional
acks The number of acknowledgments the producer requires the leader to
have received before considering a request complete. Allowed values: 0
for no acknowledgments, 1 for only the leader and -1 for the full ISR.
timeout The time to await a response in ms.
topic_data null
topic Name of topic
data null
partition Topic partition id
record_set null
Produce Request (Version: 4) => transactional_id acks timeout [topic_data]
transactional_id => NULLABLE_STRING
acks => INT16
timeout => INT32
topic_data => topic [data]
topic => STRING
data => partition record_set
partition => INT32
record_set => RECORDS
Field Description
transactional_id The transactional id or null if the producer is not
transactional
acks The number of acknowledgments the producer requires the leader to
have received before considering a request complete. Allowed values: 0
for no acknowledgments, 1 for only the leader and -1 for the full ISR.
timeout The time to await a response in ms.
topic_data null
topic Name of topic
data null
partition Topic partition id
record_set null
Produce Request (Version: 5) => transactional_id acks timeout [topic_data]
transactional_id => NULLABLE_STRING
acks => INT16
timeout => INT32
topic_data => topic [data]
topic => STRING
data => partition record_set
partition => INT32
record_set => RECORDS
Field Description
transactional_id The transactional id or null if the producer is not
transactional
acks The number of acknowledgments the producer requires the leader to
have received before considering a request complete. Allowed values: 0
for no acknowledgments, 1 for only the leader and -1 for the full ISR.
timeout The time to await a response in ms.
topic_data null
topic Name of topic
data null
partition Topic partition id
record_set null
Produce Request (Version: 6) => transactional_id acks timeout [topic_data]
transactional_id => NULLABLE_STRING
acks => INT16
timeout => INT32
topic_data => topic [data]
topic => STRING
data => partition record_set
partition => INT32
record_set => RECORDS
Field Description
transactional_id The transactional id or null if the producer is not
transactional
acks The number of acknowledgments the producer requires the leader to
have received before considering a request complete. Allowed values: 0
for no acknowledgments, 1 for only the leader and -1 for the full ISR.
timeout The time to await a response in ms.
topic_data null
topic Name of topic
data null
partition Topic partition id
record_set null
Produce Request (Version: 7) => transactional_id acks timeout [topic_data]
transactional_id => NULLABLE_STRING
acks => INT16
timeout => INT32
topic_data => topic [data]
topic => STRING
data => partition record_set
partition => INT32
record_set => RECORDS
Field Description
transactional_id The transactional id or null if the producer is not
transactional
acks The number of acknowledgments the producer requires the leader to
have received before considering a request complete. Allowed values: 0
for no acknowledgments, 1 for only the leader and -1 for the full ISR.
timeout The time to await a response in ms.
topic_data null
topic Name of topic
data null
partition Topic partition id
record_set null
Produce Response (Version: 0) => [responses]
responses => topic [partition_responses]
topic => STRING
partition_responses => partition error_code base_offset
partition => INT32
error_code => INT16
base_offset => INT64
Field Description
responses null
topic Name of topic
partition_responses null
partition Topic partition id
error_code Response error code
base_offset null
Produce Response (Version: 1) => [responses] throttle_time_ms
responses => topic [partition_responses]
topic => STRING
partition_responses => partition error_code base_offset
partition => INT32
error_code => INT16
base_offset => INT64
throttle_time_ms => INT32
Field Description
responses null
topic Name of topic
partition_responses null
partition Topic partition id
error_code Response error code
base_offset null
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
Produce Response (Version: 2) => [responses] throttle_time_ms
responses => topic [partition_responses]
topic => STRING
partition_responses => partition error_code base_offset log_append_time
partition => INT32
error_code => INT16
base_offset => INT64
log_append_time => INT64
throttle_time_ms => INT32
Field Description
responses null
topic Name of topic
partition_responses null
partition Topic partition id
error_code Response error code
base_offset null
log_append_time The timestamp returned by broker after appending the
messages. If CreateTime is used for the topic, the timestamp will be -1.
If LogAppendTime is used for the topic, the timestamp will be the broker
local time when the messages are appended.
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
Produce Response (Version: 3) => [responses] throttle_time_ms
responses => topic [partition_responses]
topic => STRING
partition_responses => partition error_code base_offset log_append_time
partition => INT32
error_code => INT16
base_offset => INT64
log_append_time => INT64
throttle_time_ms => INT32
Field Description
responses null
topic Name of topic
partition_responses null
partition Topic partition id
error_code Response error code
base_offset null
log_append_time The timestamp returned by broker after appending the
messages. If CreateTime is used for the topic, the timestamp will be -1.
If LogAppendTime is used for the topic, the timestamp will be the broker
local time when the messages are appended.
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
Produce Response (Version: 4) => [responses] throttle_time_ms
responses => topic [partition_responses]
topic => STRING
partition_responses => partition error_code base_offset log_append_time
partition => INT32
error_code => INT16
base_offset => INT64
log_append_time => INT64
throttle_time_ms => INT32
Field Description
responses null
topic Name of topic
partition_responses null
partition Topic partition id
error_code Response error code
base_offset null
log_append_time The timestamp returned by broker after appending the
messages. If CreateTime is used for the topic, the timestamp will be -1.
If LogAppendTime is used for the topic, the timestamp will be the broker
local time when the messages are appended.
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
Produce Response (Version: 5) => [responses] throttle_time_ms
responses => topic [partition_responses]
topic => STRING
partition_responses => partition error_code base_offset log_append_time log_start_offset
partition => INT32
error_code => INT16
base_offset => INT64
log_append_time => INT64
log_start_offset => INT64
throttle_time_ms => INT32
Field Description
responses null
topic Name of topic
partition_responses null
partition Topic partition id
error_code Response error code
base_offset null
log_append_time The timestamp returned by broker after appending the
messages. If CreateTime is used for the topic, the timestamp will be -1.
If LogAppendTime is used for the topic, the timestamp will be the broker
local time when the messages are appended.
log_start_offset The start offset of the log at the time this produce
response was created
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
Produce Response (Version: 6) => [responses] throttle_time_ms
responses => topic [partition_responses]
topic => STRING
partition_responses => partition error_code base_offset log_append_time log_start_offset
partition => INT32
error_code => INT16
base_offset => INT64
log_append_time => INT64
log_start_offset => INT64
throttle_time_ms => INT32
Field Description
responses null
topic Name of topic
partition_responses null
partition Topic partition id
error_code Response error code
base_offset null
log_append_time The timestamp returned by broker after appending the
messages. If CreateTime is used for the topic, the timestamp will be -1.
If LogAppendTime is used for the topic, the timestamp will be the broker
local time when the messages are appended.
log_start_offset The start offset of the log at the time this produce
response was created
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
Produce Response (Version: 7) => [responses] throttle_time_ms
responses => topic [partition_responses]
topic => STRING
partition_responses => partition error_code base_offset log_append_time log_start_offset
partition => INT32
error_code => INT16
base_offset => INT64
log_append_time => INT64
log_start_offset => INT64
throttle_time_ms => INT32
Field Description
responses null
topic Name of topic
partition_responses null
partition Topic partition id
error_code Response error code
base_offset null
log_append_time The timestamp returned by broker after appending the
messages. If CreateTime is used for the topic, the timestamp will be -1.
If LogAppendTime is used for the topic, the timestamp will be the broker
local time when the messages are appended.
log_start_offset The start offset of the log at the time this produce
response was created
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
Fetch API (Key: 1):
*Requests:*
Fetch Request (Version: 0) => replica_id max_wait_time min_bytes [topics]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
partition_max_bytes => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
partition_max_bytes Maximum bytes to fetch.
Fetch Request (Version: 1) => replica_id max_wait_time min_bytes [topics]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
partition_max_bytes => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
partition_max_bytes Maximum bytes to fetch.
Fetch Request (Version: 2) => replica_id max_wait_time min_bytes [topics]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
partition_max_bytes => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
partition_max_bytes Maximum bytes to fetch.
Fetch Request (Version: 3) => replica_id max_wait_time min_bytes max_bytes [topics]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
max_bytes => INT32
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
partition_max_bytes => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
max_bytes Maximum bytes to accumulate in the response. Note that this is
not an absolute maximum, if the first message in the first non-empty
partition of the fetch is larger than this value, the message will still
be returned to ensure that progress can be made.
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
partition_max_bytes Maximum bytes to fetch.
Fetch Request (Version: 4) => replica_id max_wait_time min_bytes max_bytes isolation_level [topics]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
max_bytes => INT32
isolation_level => INT8
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
partition_max_bytes => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
max_bytes Maximum bytes to accumulate in the response. Note that this is
not an absolute maximum, if the first message in the first non-empty
partition of the fetch is larger than this value, the message will still
be returned to ensure that progress can be made.
isolation_level This setting controls the visibility of transactional
records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records
visible. With READ_COMMITTED (isolation_level = 1), non-transactional
and COMMITTED transactional records are visible. To be more concrete,
READ_COMMITTED returns all data from offsets smaller than the current
LSO (last stable offset), and enables the inclusion of the list of
aborted transactions in the result, which allows consumers to discard
ABORTED transactional records
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
partition_max_bytes Maximum bytes to fetch.
Fetch Request (Version: 5) => replica_id max_wait_time min_bytes max_bytes isolation_level [topics]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
max_bytes => INT32
isolation_level => INT8
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset log_start_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
log_start_offset => INT64
partition_max_bytes => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
max_bytes Maximum bytes to accumulate in the response. Note that this is
not an absolute maximum, if the first message in the first non-empty
partition of the fetch is larger than this value, the message will still
be returned to ensure that progress can be made.
isolation_level This setting controls the visibility of transactional
records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records
visible. With READ_COMMITTED (isolation_level = 1), non-transactional
and COMMITTED transactional records are visible. To be more concrete,
READ_COMMITTED returns all data from offsets smaller than the current
LSO (last stable offset), and enables the inclusion of the list of
aborted transactions in the result, which allows consumers to discard
ABORTED transactional records
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
log_start_offset Earliest available offset of the follower replica. The
field is only used when request is sent by follower.
partition_max_bytes Maximum bytes to fetch.
Fetch Request (Version: 6) => replica_id max_wait_time min_bytes max_bytes isolation_level [topics]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
max_bytes => INT32
isolation_level => INT8
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset log_start_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
log_start_offset => INT64
partition_max_bytes => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
max_bytes Maximum bytes to accumulate in the response. Note that this is
not an absolute maximum, if the first message in the first non-empty
partition of the fetch is larger than this value, the message will still
be returned to ensure that progress can be made.
isolation_level This setting controls the visibility of transactional
records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records
visible. With READ_COMMITTED (isolation_level = 1), non-transactional
and COMMITTED transactional records are visible. To be more concrete,
READ_COMMITTED returns all data from offsets smaller than the current
LSO (last stable offset), and enables the inclusion of the list of
aborted transactions in the result, which allows consumers to discard
ABORTED transactional records
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
log_start_offset Earliest available offset of the follower replica. The
field is only used when request is sent by follower.
partition_max_bytes Maximum bytes to fetch.
Fetch Request (Version: 7) => replica_id max_wait_time min_bytes max_bytes isolation_level session_id session_epoch [topics] [forgotten_topics_data]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
max_bytes => INT32
isolation_level => INT8
session_id => INT32
session_epoch => INT32
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset log_start_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
log_start_offset => INT64
partition_max_bytes => INT32
forgotten_topics_data => topic [partitions]
topic => STRING
partitions => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
max_bytes Maximum bytes to accumulate in the response. Note that this is
not an absolute maximum, if the first message in the first non-empty
partition of the fetch is larger than this value, the message will still
be returned to ensure that progress can be made.
isolation_level This setting controls the visibility of transactional
records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records
visible. With READ_COMMITTED (isolation_level = 1), non-transactional
and COMMITTED transactional records are visible. To be more concrete,
READ_COMMITTED returns all data from offsets smaller than the current
LSO (last stable offset), and enables the inclusion of the list of
aborted transactions in the result, which allows consumers to discard
ABORTED transactional records
session_id The fetch session ID
session_epoch The fetch session epoch
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
log_start_offset Earliest available offset of the follower replica. The
field is only used when request is sent by follower.
partition_max_bytes Maximum bytes to fetch.
forgotten_topics_data Topics to remove from the fetch session.
topic Name of topic
partitions Partitions to remove from the fetch session.
Fetch Request (Version: 8) => replica_id max_wait_time min_bytes max_bytes isolation_level session_id session_epoch [topics] [forgotten_topics_data]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
max_bytes => INT32
isolation_level => INT8
session_id => INT32
session_epoch => INT32
topics => topic [partitions]
topic => STRING
partitions => partition fetch_offset log_start_offset partition_max_bytes
partition => INT32
fetch_offset => INT64
log_start_offset => INT64
partition_max_bytes => INT32
forgotten_topics_data => topic [partitions]
topic => STRING
partitions => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
max_bytes Maximum bytes to accumulate in the response. Note that this is
not an absolute maximum, if the first message in the first non-empty
partition of the fetch is larger than this value, the message will still
be returned to ensure that progress can be made.
isolation_level This setting controls the visibility of transactional
records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records
visible. With READ_COMMITTED (isolation_level = 1), non-transactional
and COMMITTED transactional records are visible. To be more concrete,
READ_COMMITTED returns all data from offsets smaller than the current
LSO (last stable offset), and enables the inclusion of the list of
aborted transactions in the result, which allows consumers to discard
ABORTED transactional records
session_id The fetch session ID
session_epoch The fetch session epoch
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
fetch_offset Message offset.
log_start_offset Earliest available offset of the follower replica. The
field is only used when request is sent by follower.
partition_max_bytes Maximum bytes to fetch.
forgotten_topics_data Topics to remove from the fetch session.
topic Name of topic
partitions Partitions to remove from the fetch session.
Fetch Request (Version: 9) => replica_id max_wait_time min_bytes max_bytes isolation_level session_id session_epoch [topics] [forgotten_topics_data]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
max_bytes => INT32
isolation_level => INT8
session_id => INT32
session_epoch => INT32
topics => topic [partitions]
topic => STRING
partitions => partition current_leader_epoch fetch_offset log_start_offset partition_max_bytes
partition => INT32
current_leader_epoch => INT32
fetch_offset => INT64
log_start_offset => INT64
partition_max_bytes => INT32
forgotten_topics_data => topic [partitions]
topic => STRING
partitions => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
max_bytes Maximum bytes to accumulate in the response. Note that this is
not an absolute maximum, if the first message in the first non-empty
partition of the fetch is larger than this value, the message will still
be returned to ensure that progress can be made.
isolation_level This setting controls the visibility of transactional
records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records
visible. With READ_COMMITTED (isolation_level = 1), non-transactional
and COMMITTED transactional records are visible. To be more concrete,
READ_COMMITTED returns all data from offsets smaller than the current
LSO (last stable offset), and enables the inclusion of the list of
aborted transactions in the result, which allows consumers to discard
ABORTED transactional records
session_id The fetch session ID
session_epoch The fetch session epoch
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
current_leader_epoch The current leader epoch, if provided, is used to
fence consumers/replicas with old metadata. If the epoch provided by the
client is larger than the current epoch known to the broker, then the
UNKNOWN_LEADER_EPOCH error code will be returned. If the provided epoch
is smaller, then the FENCED_LEADER_EPOCH error code will be returned.
fetch_offset Message offset.
log_start_offset Earliest available offset of the follower replica. The
field is only used when request is sent by follower.
partition_max_bytes Maximum bytes to fetch.
forgotten_topics_data Topics to remove from the fetch session.
topic Name of topic
partitions Partitions to remove from the fetch session.
Fetch Request (Version: 10) => replica_id max_wait_time min_bytes max_bytes isolation_level session_id session_epoch [topics] [forgotten_topics_data]
replica_id => INT32
max_wait_time => INT32
min_bytes => INT32
max_bytes => INT32
isolation_level => INT8
session_id => INT32
session_epoch => INT32
topics => topic [partitions]
topic => STRING
partitions => partition current_leader_epoch fetch_offset log_start_offset partition_max_bytes
partition => INT32
current_leader_epoch => INT32
fetch_offset => INT64
log_start_offset => INT64
partition_max_bytes => INT32
forgotten_topics_data => topic [partitions]
topic => STRING
partitions => INT32
Field Description
replica_id Broker id of the follower. For normal consumers, use -1.
max_wait_time Maximum time in ms to wait for the response.
min_bytes Minimum bytes to accumulate in the response.
max_bytes Maximum bytes to accumulate in the response. Note that this is
not an absolute maximum, if the first message in the first non-empty
partition of the fetch is larger than this value, the message will still
be returned to ensure that progress can be made.
isolation_level This setting controls the visibility of transactional
records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records
visible. With READ_COMMITTED (isolation_level = 1), non-transactional
and COMMITTED transactional records are visible. To be more concrete,
READ_COMMITTED returns all data from offsets smaller than the current
LSO (last stable offset), and enables the inclusion of the list of
aborted transactions in the result, which allows consumers to discard
ABORTED transactional records
session_id The fetch session ID
session_epoch The fetch session epoch
topics Topics to fetch in the order provided.
topic Name of topic
partitions Partitions to fetch.
partition Topic partition id
current_leader_epoch The current leader epoch, if provided, is used to
fence consumers/replicas with old metadata. If the epoch provided by the
client is larger than the current epoch known to the broker, then the
UNKNOWN_LEADER_EPOCH error code will be returned. If the provided epoch
is smaller, then the FENCED_LEADER_EPOCH error code will be returned.
fetch_offset Message offset.
log_start_offset Earliest available offset of the follower replica. The
field is only used when request is sent by follower.
partition_max_bytes Maximum bytes to fetch.
forgotten_topics_data Topics to remove from the fetch session.
topic Name of topic
partitions Partitions to remove from the fetch session.
Fetch Response (Version: 0) => [responses]
responses => topic [partition_responses]
topic => STRING
partition_responses => partition_header record_set
partition_header => partition error_code high_watermark
partition => INT32
error_code => INT16
high_watermark => INT64
record_set => RECORDS
Field Description
responses null
topic Name of topic
partition_responses null
partition_header null
partition Topic partition id
error_code Response error code
high_watermark Last committed offset.
record_set null
Fetch Response (Version: 1) => throttle_time_ms [responses]
throttle_time_ms => INT32
responses => topic [partition_responses]
topic => STRING
partition_responses => partition_header record_set
partition_header => partition error_code high_watermark
partition => INT32
error_code => INT16
high_watermark => INT64
record_set => RECORDS
Field Description
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
responses null
topic Name of topic
partition_responses null
partition_header null
partition Topic partition id
error_code Response error code
high_watermark Last committed offset.
record_set null
Fetch Response (Version: 2) => throttle_time_ms [responses]
throttle_time_ms => INT32
responses => topic [partition_responses]
topic => STRING
partition_responses => partition_header record_set
partition_header => partition error_code high_watermark
partition => INT32
error_code => INT16
high_watermark => INT64
record_set => RECORDS
Field Description
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
responses null
topic Name of topic
partition_responses null
partition_header null
partition Topic partition id
error_code Response error code
high_watermark Last committed offset.
record_set null
Fetch Response (Version: 3) => throttle_time_ms [responses]
throttle_time_ms => INT32
responses => topic [partition_responses]
topic => STRING
partition_responses => partition_header record_set
partition_header => partition error_code high_watermark
partition => INT32
error_code => INT16
high_watermark => INT64
record_set => RECORDS
Field Description
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
responses null
topic Name of topic
partition_responses null
partition_header null
partition Topic partition id
error_code Response error code
high_watermark Last committed offset.
record_set null
Fetch Response (Version: 4) => throttle_time_ms [responses]
throttle_time_ms => INT32
responses => topic [partition_responses]
topic => STRING
partition_responses => partition_header record_set
partition_header => partition error_code high_watermark last_stable_offset [aborted_transactions]
partition => INT32
error_code => INT16
high_watermark => INT64
last_stable_offset => INT64
aborted_transactions => producer_id first_offset
producer_id => INT64
first_offset => INT64
record_set => RECORDS
Field Description
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
responses null
topic Name of topic
partition_responses null
partition_header null
partition Topic partition id
error_code Response error code
high_watermark Last committed offset.
last_stable_offset The last stable offset (or LSO) of the partition.
This is the last offset such that the state of all transactional records
prior to this offset have been decided (ABORTED or COMMITTED)
aborted_transactions null
producer_id The producer id associated with the aborted transactions
first_offset The first offset in the aborted transaction
record_set null
Fetch Response (Version: 5) => throttle_time_ms [responses]
throttle_time_ms => INT32
responses => topic [partition_responses]
topic => STRING
partition_responses => partition_header record_set
partition_header => partition error_code high_watermark last_stable_offset log_start_offset [aborted_transactions]
partition => INT32
error_code => INT16
high_watermark => INT64
last_stable_offset => INT64
log_start_offset => INT64
aborted_transactions => producer_id first_offset
producer_id => INT64
first_offset => INT64
record_set => RECORDS
Field Description
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
responses null
topic Name of topic
partition_responses null
partition_header null
partition Topic partition id
error_code Response error code
high_watermark Last committed offset.
last_stable_offset The last stable offset (or LSO) of the partition.
This is the last offset such that the state of all transactional records
prior to this offset have been decided (ABORTED or COMMITTED)
log_start_offset Earliest available offset.
aborted_transactions null
producer_id The producer id associated with the aborted transactions
first_offset The first offset in the aborted transaction
record_set null
Fetch Response (Version: 6) => throttle_time_ms [responses]
throttle_time_ms => INT32
responses => topic [partition_responses]
topic => STRING
partition_responses => partition_header record_set
partition_header => partition error_code high_watermark last_stable_offset log_start_offset [aborted_transactions]
partition => INT32
error_code => INT16
high_watermark => INT64
last_stable_offset => INT64
log_start_offset => INT64
aborted_transactions => producer_id first_offset
producer_id => INT64
first_offset => INT64
record_set => RECORDS
Field Description
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
responses null
topic Name of topic
partition_responses null
partition_header null
partition Topic partition id
error_code Response error code
high_watermark Last committed offset.
last_stable_offset The last stable offset (or LSO) of the partition.
This is the last offset such that the state of all transactional records
prior to this offset have been decided (ABORTED or COMMITTED)
log_start_offset Earliest available offset.
aborted_transactions null
producer_id The producer id associated with the aborted transactions
first_offset The first offset in the aborted transaction
record_set null
Fetch Response (Version: 7) => throttle_time_ms error_code session_id [responses]
throttle_time_ms => INT32
error_code => INT16
session_id => INT32
responses => topic [partition_responses]
topic => STRING
partition_responses => partition_header record_set
partition_header => partition error_code high_watermark last_stable_offset log_start_offset [aborted_transactions]
partition => INT32
error_code => INT16
high_watermark => INT64
last_stable_offset => INT64
log_start_offset => INT64
aborted_transactions => producer_id first_offset
producer_id => INT64
first_offset => INT64
record_set => RECORDS
Field Description
throttle_time_ms Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)
error_code Response error code
session_id The fetch session ID
responses null
topic Name of topic
partition_responses null
partition_header null
partition Topic partition id
error_code Response error code
high_watermark Last committed offset.
last_stable_offset The last stable offset (or LSO) of the partition.
This is the last offset such that the state of all transactional records
prior to this offset have been decided (ABORTED or COMMITTED)