View Source KafkaEx.Messages.ConsumerGroupDescription (kafka_ex v1.0.0-rc.1)

A detailed description of a single consumer group in the cluster.

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

Contains information about a consumer group's state, protocol, and members as returned by the DescribeGroups API.

Summary

Types

t()

Functions

from_describe_group_response(describe_group)

Builds a ConsumerGroupDescription from a DescribeGroups API response.

group_id(consumer_group_description)

Returns the group ID.

members(consumer_group_description)

Returns the list of members in the group.

stable?(consumer_group_description)

Returns whether the group is in the Stable state.

state(consumer_group_description)

Returns the current state of the group.

Types

Link to this type

t()

View Source 
@type t() :: %KafkaEx.Messages.ConsumerGroupDescription{
  authorized_operations: integer() | nil,
  group_id: binary(),
  members: [KafkaEx.Messages.ConsumerGroupDescription.Member.t()],
  protocol: binary(),
  protocol_type: binary(),
  state: binary()
}

Functions

Link to this function

from_describe_group_response(describe_group)

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

Builds a ConsumerGroupDescription from a DescribeGroups API response.

Link to this function

group_id(consumer_group_description)

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

Returns the group ID.

Link to this function

members(consumer_group_description)

View Source 
@spec members(t()) :: [KafkaEx.Messages.ConsumerGroupDescription.Member.t()]

Returns the list of members in the group.

Link to this function

stable?(consumer_group_description)

View Source 
@spec stable?(t()) :: boolean()

Returns whether the group is in the Stable state.

Link to this function

state(consumer_group_description)

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

Returns the current state of the group.