View Source KlifeProtocol.Messages.ListGroups (Klife Protocol v0.5.0)

Kafka protocol ListGroups message

Request versions summary:

  • Version 1 and 2 are the same as version 0.
  • Version 3 is the first flexible version.
  • Version 4 adds the StatesFilter field (KIP-518).
  • Version 5 adds the TypesFilter field (KIP-848).

Response versions summary:

  • Version 1 adds the throttle time.
  • Starting in version 2, on quota violation, brokers send out responses before throttling.
  • Version 3 is the first flexible version.
  • Version 4 adds the GroupState field (KIP-518).
  • Version 5 adds the GroupType field (KIP-848).

Link to this section Summary

Functions

Returns the message api key number.

Receive a binary in the kafka wire format and deserialize it into a map.

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Receives a map and serialize it to kafka wire format of the given version.

Link to this section Functions

Returns the message api key number.

Link to this function

deserialize_response(data, version, with_header? \\ true)

View Source

Receive a binary in the kafka wire format and deserialize it into a map.

Response content fields:

  • throttle_time_ms: 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. (int32 | versions 1+)

  • error_code: The error code, or 0 if there was no error. (int16 | versions 0+)

  • groups: Each group in the response. ([]ListedGroup | versions 0+)

    • group_id: The group ID. (string | versions 0+)

    • protocol_type: The group protocol type. (string | versions 0+)

    • group_state: The group state name. (string | versions 4+)

    • group_type: The group type name. (string | versions 5+)

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Link to this function

serialize_request(map, version)

View Source

Receives a map and serialize it to kafka wire format of the given version.

Input content fields:

  • states_filter: The states of the groups we want to list. If empty, all groups are returned with their state. ([]string | versions 4+)

  • types_filter: The types of the groups we want to list. If empty, all groups are returned with their type. ([]string | versions 5+)