View Source KafkaEx.Protocol.Kayrock.DescribeGroups.RequestHelpers (kafka_ex v1.0.0-rc.1)

Shared helper functions for building DescribeGroups requests across all versions.

Version differences:

  • V0-V2: groups (array of group IDs) -- all schema-identical
  • V3-V5: Adds include_authorized_operations boolean (KIP-430)
  • V5: Flexible version (KIP-482) with compact encoding -- Kayrock handles encoding

Summary

Functions

build_request_from_template(request_template, opts)

Builds a DescribeGroups request by populating the request template with the groups list. This is shared logic between V0-V2 requests as they have identical structure.

build_v3_plus_request(request_template, opts)

Builds a DescribeGroups V3+ request by populating the request template with groups list plus include_authorized_operations (KIP-430).

Functions

Link to this function

build_request_from_template(request_template, opts)

View Source 
@spec build_request_from_template(map(), Keyword.t()) :: map()

Builds a DescribeGroups request by populating the request template with the groups list. This is shared logic between V0-V2 requests as they have identical structure.

Options

  • group_names (required): List of consumer group IDs to describe
Link to this function

build_v3_plus_request(request_template, opts)

View Source 
@spec build_v3_plus_request(map(), Keyword.t()) :: map()

Builds a DescribeGroups V3+ request by populating the request template with groups list plus include_authorized_operations (KIP-430).

V3/V4 add include_authorized_operations: :boolean. V5 is the flexible version (KIP-482) with the same logical fields -- Kayrock handles compact encoding.

Options

  • group_names (required): List of consumer group IDs to describe
  • include_authorized_operations (optional): Whether to include authorized operations (defaults to false)