View Source KafkaEx.Messages.ConsumerGroupListing (kafka_ex v1.1.0)

A lightweight listing of a single consumer group in the cluster.

Java equivalent: org.apache.kafka.clients.admin.ConsumerGroupListing

Returned by the ListGroups API. Carries only the group id and protocol type; use KafkaEx.API.describe_group/2 for full group detail (state, members, ...).

Summary

Types

t()

Functions

from_list_groups_response(group)

Builds a ConsumerGroupListing from a ListGroups API response group entry.

group_id(consumer_group_listing)

Returns the group ID.

protocol_type(consumer_group_listing)

Returns the protocol type (e.g. "consumer").

Types

Link to this type

t()

View Source 
@type t() :: %KafkaEx.Messages.ConsumerGroupListing{
  group_id: binary(),
  protocol_type: binary()
}

Functions

Link to this function

from_list_groups_response(group)

View Source 
@spec from_list_groups_response(map()) :: t()

Builds a ConsumerGroupListing from a ListGroups API response group entry.

Link to this function

group_id(consumer_group_listing)

View Source 
@spec group_id(t()) :: binary()

Returns the group ID.

Link to this function

protocol_type(consumer_group_listing)

View Source 
@spec protocol_type(t()) :: binary()

Returns the protocol type (e.g. "consumer").