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

Kafka protocol DescribeGroups message

Request versions summary:

  • Versions 1 and 2 are the same as version 0.
  • Starting in version 3, authorized operations can be requested.
  • Starting in version 4, the response will include group.instance.id info for members.
  • Version 5 is the first flexible version.

Response versions summary:

  • Version 1 added throttle time.
  • Starting in version 2, on quota violation, brokers send out responses before throttling.
  • Starting in version 3, brokers can send authorized operations.
  • Starting in version 4, the response will optionally include group.instance.id info for members.
  • Version 5 is the first flexible version.

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+)

  • groups: Each described group. ([]DescribedGroup | versions 0+)

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

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

    • group_state: The group state string, or the empty string. (string | versions 0+)

    • protocol_type: The group protocol type, or the empty string. (string | versions 0+)

    • protocol_data: The group protocol data, or the empty string. (string | versions 0+)

    • members: The group members. ([]DescribedGroupMember | versions 0+)

      • member_id: The member ID assigned by the group coordinator. (string | versions 0+)

      • group_instance_id: The unique identifier of the consumer instance provided by end user. (string | versions 4+)

      • client_id: The client ID used in the member's latest join group request. (string | versions 0+)

      • client_host: The client host. (string | versions 0+)

      • member_metadata: The metadata corresponding to the current group protocol in use. (bytes | versions 0+)

      • member_assignment: The current assignment provided by the group leader. (bytes | versions 0+)

    • authorized_operations: 32-bit bitfield to represent authorized operations for this group. (int32 | versions 3+)

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:

  • groups: The names of the groups to describe ([]string | versions 0+)

  • include_authorized_operations: Whether to include authorized operations. (bool | versions 3+)