Skip to content
m manifester.io
All Kafka APIs

InitializeShareGroupState

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 0 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
83
Encoded at
v0
Flexible versions
0+
Headers
req v2, resp v1
Request versions
0
Response versions
0
Request size
53 bytes
Response size
37 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields

Request

InitializeShareGroupStateRequest v0, request header v2, 53 bytes on the wire

byte layout (53 bytes, 16 bytes per row)

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

object tree

InitializeShareGroupStateRequest       message v0                                                     [0x0000, 53B]
+-- Frame                                                                                             [0x0000, 4B]   length-delimited framing
|   +-- size                           int32                  = 49                                    [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- RequestHeader                      v2                                                             [0x0004, 11B]  common request header
|   +-- request_api_key                int16                  = 83 (InitializeShareGroupState)        [0x0004, 2B]   numeric id of the API being invoked
|   +-- request_api_version            int16                  = 0                                     [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
+-- InitializeShareGroupStateRequest   struct                                                         [0x000f, 38B]  message body, version 0
    +-- GroupId                        string                 = "" (compact, len+1=1)                 [0x000f, 1B]   The group identifier.
    +-- Topics                         []InitializeStateData  = 1 element                             [0x0010, 36B]  The data for the topics.
    |   +-- length                     uvarint                = 2 (compact, n+1)                      [0x0010, 1B]   one sample element follows
    |   +-- InitializeStateData[0]     InitializeStateData    = struct                                [0x0011, 35B]
    |       +-- TopicId                uuid                   = 00000000-0000-0000-0000-000000000000  [0x0011, 16B]  The topic identifier.
    |       +-- Partitions             []PartitionData        = 1 element                             [0x0021, 18B]  The data for the partitions.
    |       |   +-- length             uvarint                = 2 (compact, n+1)                      [0x0021, 1B]   one sample element follows
    |       |   +-- PartitionData[0]   PartitionData          = struct                                [0x0022, 17B]
    |       |       +-- Partition      int32                  = 0                                     [0x0022, 4B]   The partition index.
    |       |       +-- StateEpoch     int32                  = 0                                     [0x0026, 4B]   The state epoch for this share-partition.
    |       |       +-- StartOffset    int64                  = 0                                     [0x002a, 8B]   The share-partition start offset, or -1 if the start offset is not being in...
    |       |       +-- tagged_fields  uvarint                = 0                                     [0x0032, 1B]   number of tagged fields in this struct
    |       +-- tagged_fields          uvarint                = 0                                     [0x0033, 1B]   number of tagged fields in this struct
    +-- tagged_fields                  uvarint                = 0                                     [0x0034, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 83,
  "type": "request",
  "listeners": ["broker"],
  "name": "InitializeShareGroupStateRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "latestVersionUnstable": true,
  "fields": [
    { "name": "GroupId", "type": "string", "versions": "0+",
      "about": "The group identifier." },
    { "name": "Topics", "type": "[]InitializeStateData", "versions": "0+",
      "about": "The data for the topics.", "fields": [
      { "name": "TopicId", "type": "uuid", "versions": "0+",
        "about": "The topic identifier." },
      { "name": "Partitions", "type": "[]PartitionData", "versions": "0+",
        "about":  "The data for the partitions.", "fields": [
        { "name": "Partition", "type": "int32", "versions": "0+",
          "about": "The partition index." },
        { "name": "StateEpoch", "type": "int32", "versions": "0+",
          "about": "The state epoch for this share-partition." },
        { "name": "StartOffset", "type": "int64", "versions": "0+",
          "about": "The share-partition start offset, or -1 if the start offset is not being initialized." }
      ]}
    ]}
  ]
}

Response

InitializeShareGroupStateResponse v0, response header v1, 37 bytes on the wire

byte layout (37 bytes, 16 bytes per row)

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

object tree

InitializeShareGroupStateResponse       message v0                                                       [0x0000, 37B]
+-- Frame                                                                                                [0x0000, 4B]   length-delimited framing
|   +-- size                            int32                    = 33                                    [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
+-- InitializeShareGroupStateResponse   struct                                                           [0x0009, 28B]  message body, version 0
    +-- Results                         []InitializeStateResult  = 1 element                             [0x0009, 27B]  The initialization results.
    |   +-- length                      uvarint                  = 2 (compact, n+1)                      [0x0009, 1B]   one sample element follows
    |   +-- InitializeStateResult[0]    InitializeStateResult    = struct                                [0x000a, 26B]
    |       +-- TopicId                 uuid                     = 00000000-0000-0000-0000-000000000000  [0x000a, 16B]  The topic identifier.
    |       +-- Partitions              []PartitionResult        = 1 element                             [0x001a, 9B]   The results for the partitions.
    |       |   +-- length              uvarint                  = 2 (compact, n+1)                      [0x001a, 1B]   one sample element follows
    |       |   +-- PartitionResult[0]  PartitionResult          = struct                                [0x001b, 8B]
    |       |       +-- Partition       int32                    = 0                                     [0x001b, 4B]   The partition index.
    |       |       +-- ErrorCode       int16                    = 0                                     [0x001f, 2B]   The error code, or 0 if there was no error.
    |       |       +-- ErrorMessage    string                   = "" (compact, len+1=1)                 [0x0021, 1B]   The error message, or null if there was no error.
    |       |       +-- tagged_fields   uvarint                  = 0                                     [0x0022, 1B]   number of tagged fields in this struct
    |       +-- tagged_fields           uvarint                  = 0                                     [0x0023, 1B]   number of tagged fields in this struct
    +-- tagged_fields                   uvarint                  = 0                                     [0x0024, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 83,
  "type": "response",
  "name": "InitializeShareGroupStateResponse",
  "validVersions": "0",
  "flexibleVersions": "0+",
  // - NOT_COORDINATOR (version 0+)
  // - COORDINATOR_NOT_AVAILABLE (version 0+)
  // - COORDINATOR_LOAD_IN_PROGRESS (version 0+)
  // - FENCED_STATE_EPOCH (version 0+)
  // - INVALID_REQUEST (version 0+)
  "fields": [
    { "name": "Results", "type": "[]InitializeStateResult", "versions": "0+",
      "about": "The initialization results.", "fields": [
      { "name": "TopicId", "type": "uuid", "versions": "0+",
        "about": "The topic identifier." },
      { "name": "Partitions", "type": "[]PartitionResult", "versions": "0+",
        "about" : "The results for the partitions.", "fields": [
        { "name": "Partition", "type": "int32", "versions": "0+",
          "about": "The partition index." },
        { "name": "ErrorCode", "type": "int16", "versions": "0+",
          "about": "The error code, or 0 if there was no error." },
        { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null",
          "about": "The error message, or null if there was no error." }
      ]}
    ]}
  ]
}