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

Kafka protocol ConsumerGroupDescribe message

Request versions summary:

Response versions summary:

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

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

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

    • error_message: The top-level error message, or null if there was no error. (string | versions 0+)

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

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

    • group_epoch: The group epoch. (int32 | versions 0+)

    • assignment_epoch: The assignment epoch. (int32 | versions 0+)

    • assignor_name: The selected assignor. (string | versions 0+)

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

      • member_id: The member ID. (string | versions 0+)

      • instance_id: The member instance ID. (string | versions 0+)

      • rack_id: The member rack ID. (string | versions 0+)

      • member_epoch: The current member epoch. (int32 | versions 0+)

      • client_id: The client ID. (string | versions 0+)

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

      • subscribed_topic_names: The subscribed topic names. ([]string | versions 0+)

      • subscribed_topic_regex: the subscribed topic regex otherwise or null of not provided. (string | versions 0+)

      • assignment: The current assignment. (Assignment | versions 0+)

      • target_assignment: The target assignment. (Assignment | versions 0+)

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

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:

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

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