Skip to content
m manifester.io
All Kafka APIs

DeleteGroups

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 2 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
42
Encoded at
v2
Flexible versions
2+
Headers
req v2, resp v1
Request versions
0-2
Response versions
0-2
Request size
18 bytes
Response size
19 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields

Request

DeleteGroupsRequest v2, request header v2, 18 bytes on the wire

byte layout (18 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

DeleteGroupsRequest          message v2                                [0x0000, 18B]
+-- Frame                                                              [0x0000, 4B]   length-delimited framing
|   +-- size                 int32            = 14                     [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- RequestHeader            v2                                        [0x0004, 11B]  common request header
|   +-- request_api_key      int16            = 42 (DeleteGroups)      [0x0004, 2B]   numeric id of the API being invoked
|   +-- request_api_version  int16            = 2                      [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
+-- DeleteGroupsRequest      struct                                    [0x000f, 3B]   message body, version 2
    +-- GroupsNames          []string         = 1 element              [0x000f, 2B]   The group names to delete.
    |   +-- length           uvarint          = 2 (compact, n+1)       [0x000f, 1B]   one sample element follows
    |   +-- string[0]        string           = "" (compact, len+1=1)  [0x0010, 1B]
    +-- tagged_fields        uvarint          = 0                      [0x0011, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 42,
  "type": "request",
  "listeners": ["broker"],
  "name": "DeleteGroupsRequest",
  // Version 1 is the same as version 0.
  //
  // Version 2 is the first flexible version.
  "validVersions": "0-2",
  "flexibleVersions": "2+",
  "fields": [
    { "name": "GroupsNames", "type": "[]string", "versions": "0+", "entityType": "groupId",
      "about": "The group names to delete." }
  ]
}

Response

DeleteGroupsResponse v2, response header v1, 19 bytes on the wire

byte layout (19 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

DeleteGroupsResponse                 message v2                                       [0x0000, 19B]
+-- Frame                                                                             [0x0000, 4B]   length-delimited framing
|   +-- size                         int32                   = 15                     [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
+-- DeleteGroupsResponse             struct                                           [0x0009, 10B]  message body, version 2
    +-- ThrottleTimeMs               int32                   = 0                      [0x0009, 4B]   The duration in milliseconds for which the request was throttled due to a q...
    +-- Results                      []DeletableGroupResult  = 1 element              [0x000d, 5B]   The deletion results.
    |   +-- length                   uvarint                 = 2 (compact, n+1)       [0x000d, 1B]   one sample element follows
    |   +-- DeletableGroupResult[0]  DeletableGroupResult    = struct                 [0x000e, 4B]
    |       +-- GroupId              string                  = "" (compact, len+1=1)  [0x000e, 1B]   The group id.
    |       +-- ErrorCode            int16                   = 0                      [0x000f, 2B]   The deletion error, or 0 if the deletion succeeded.
    |       +-- tagged_fields        uvarint                 = 0                      [0x0011, 1B]   number of tagged fields in this struct
    +-- tagged_fields                uvarint                 = 0                      [0x0012, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 42,
  "type": "response",
  "name": "DeleteGroupsResponse",
  // Starting in version 1, on quota violation, brokers send out responses before throttling.
  //
  // Version 2 is the first flexible version.
  "validVersions": "0-2",
  "flexibleVersions": "2+",
  "fields": [
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      "about": "The 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": "Results", "type": "[]DeletableGroupResult", "versions": "0+",
      "about": "The deletion results.", "fields": [
      { "name": "GroupId", "type": "string", "versions": "0+", "mapKey": true, "entityType": "groupId",
        "about": "The group id." },
      { "name": "ErrorCode", "type": "int16", "versions": "0+",
        "about": "The deletion error, or 0 if the deletion succeeded." }
    ]}
  ]
}