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

This module represents LeaveGroup response from Kafka.

Versions

  • V0: Returns {:ok, :no_error} on success (no struct).
  • V1-V2: Returns %LeaveGroup{throttle_time_ms: ...}.
  • V3+: Returns %LeaveGroup{throttle_time_ms: ..., members: [...]} with per-member leave results including individual error codes (KIP-345 batch leave).

Summary

Functions

Builds a LeaveGroup struct from response data.

Types

@type member_result() :: %{
  member_id: String.t(),
  group_instance_id: String.t() | nil,
  error: atom()
}
@type t() :: %KafkaEx.Messages.LeaveGroup{
  members: nil | [member_result()],
  throttle_time_ms: nil | non_neg_integer()
}

Functions

@spec build(Keyword.t()) :: t()

Builds a LeaveGroup struct from response data.