m manifester.io
All Kafka APIs

AddOffsetsToTxn

This page encodes the smallest legal instance of the request and the response: numeric fields are zero, strings and byte arrays are empty, every array carries exactly one sample element, and any records field holds one empty 61-byte RecordBatch v2. Version 4 is a flexible version, so every struct is terminated by a uvarint tagged-field count and strings and arrays carry compact length-plus-one prefixes. Sizes below include the leading int32 size prefix.

API key
25
Encoded at
v4
Flexible versions
3+
Headers
req v2, resp v1
Request versions
0-4
Response versions
0-4
Request size
28 bytes
Response size
16 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields

Request

AddOffsetsToTxnRequest v4, request header v2, 28 bytes on the wire

byte layout (28 bytes, 16 bytes per row)

0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010

object tree

AddOffsetsToTxnRequest       message v4                                [0x0000, 28B]
+-- Frame                                                              [0x0000, 4B]   length-delimited framing
|   +-- size                 int32            = 24                     [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- RequestHeader            v2                                        [0x0004, 11B]  common request header
|   +-- request_api_key      int16            = 25 (AddOffsetsToTxn)   [0x0004, 2B]   numeric id of the API being invoked
|   +-- request_api_version  int16            = 4                      [0x0006, 2B]   version of the API being invoked
|   +-- correlation_id       int32            = 0                      [0x0008, 4B]   echoed back by the broker in the response
|   +-- client_id            nullable_string  = "" (int16 len=0)       [0x000c, 2B]   always a non-flexible int16-prefixed string
|   +-- tagged_fields        uvarint          = 0                      [0x000e, 1B]   number of tagged fields in the header
+-- AddOffsetsToTxnRequest   struct                                    [0x000f, 13B]  message body, version 4
    +-- TransactionalId      string           = "" (compact, len+1=1)  [0x000f, 1B]   The transactional id corresponding to the transaction.
    +-- ProducerId           int64            = 0                      [0x0010, 8B]   Current producer id in use by the transactional id.
    +-- ProducerEpoch        int16            = 0                      [0x0018, 2B]   Current epoch associated with the producer id.
    +-- GroupId              string           = "" (compact, len+1=1)  [0x001a, 1B]   The unique group identifier.
    +-- tagged_fields        uvarint          = 0                      [0x001b, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 25,
  "type": "request",
  "listeners": ["broker"],
  "name": "AddOffsetsToTxnRequest",
  // Version 1 is the same as version 0.
  //
  // Version 2 adds the support for new error code PRODUCER_FENCED.
  //
  // Version 3 enables flexible versions.
  //
  // Version 4 adds support for new error code TRANSACTION_ABORTABLE (KIP-890).
  "validVersions": "0-4",
  "flexibleVersions": "3+",
  "fields": [
    { "name": "TransactionalId", "type": "string", "versions": "0+", "entityType": "transactionalId",
      "about": "The transactional id corresponding to the transaction."},
    { "name": "ProducerId", "type": "int64", "versions": "0+", "entityType": "producerId",
      "about": "Current producer id in use by the transactional id." },
    { "name": "ProducerEpoch", "type": "int16", "versions": "0+",
      "about": "Current epoch associated with the producer id." },
    { "name": "GroupId", "type": "string", "versions": "0+", "entityType": "groupId",
      "about": "The unique group identifier." }
  ]
}

Response

AddOffsetsToTxnResponse v4, response header v1, 16 bytes on the wire

byte layout (16 bytes, 16 bytes per row)

0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000

object tree

AddOffsetsToTxnResponse      message v4        [0x0000, 16B]
+-- Frame                                      [0x0000, 4B]   length-delimited framing
|   +-- size                 int32       = 12  [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- ResponseHeader           v1                [0x0004, 5B]   common response header
|   +-- correlation_id       int32       = 0   [0x0004, 4B]   matches the correlation_id of the request
|   +-- tagged_fields        uvarint     = 0   [0x0008, 1B]   number of tagged fields in the header
+-- AddOffsetsToTxnResponse  struct            [0x0009, 7B]   message body, version 4
    +-- ThrottleTimeMs       int32       = 0   [0x0009, 4B]   Duration in milliseconds for which the request was throttled due to a quota...
    +-- ErrorCode            int16       = 0   [0x000d, 2B]   The response error code, or 0 if there was no error.
    +-- tagged_fields        uvarint     = 0   [0x000f, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 25,
  "type": "response",
  "name": "AddOffsetsToTxnResponse",
  // Starting in version 1, on quota violation brokers send out responses before throttling.
  //
  // Version 2 adds the support for new error code PRODUCER_FENCED.
  //
  // Version 3 enables flexible versions.
  //
  // Version 4 adds support for new error code TRANSACTION_ABORTABLE (KIP-890).
  "validVersions": "0-4",
  "flexibleVersions": "3+",
  "fields": [
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      "about": "Duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
    { "name": "ErrorCode", "type": "int16", "versions": "0+",
      "about": "The response error code, or 0 if there was no error." }
  ]
}