1// ListGroupsRequest issues a request to list all groups.
2//
3// To list all groups in a cluster, this must be issued to every broker.
4ListGroupsRequest => key 16, max version 4, flexible v3+
5 // StatesFilter, proposed in KIP-518 and introduced in Kafka 2.6.0,
6 // allows filtering groups by state, where a state is any of
7 // "Preparing", "PreparingRebalance", "CompletingRebalance", "Stable",
8 // "Dead", or "Empty". If empty, all groups are returned.
9 StatesFilter: [string] // v4+
10
11// ListGroupsResponse is returned from a ListGroupsRequest.
12ListGroupsResponse =>
13 ThrottleMillis(2) // v1+
14 // ErrorCode is the error returned for the list groups request.
15 //
16 // COORDINATOR_NOT_AVAILABLE is returned if the coordinator is not yet active.
17 //
18 // COORDINATOR_LOAD_IN_PROGRESS is returned if the group manager is loading.
19 ErrorCode: int16
20 // Groups is the list of groups Kafka knows of.
21 Groups: [=>]
22 // Group is a Kafka group.
23 Group: string
24 // ProtocolType is the protocol type in use by the group.
25 ProtocolType: string
26 // The group state.
27 GroupState: string // v4+
View as plain text