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

Information about a member of a consumer group.

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

Contains identifying information about a consumer group member and their current partition assignment.

Summary

Types

partial_response()
t()

Functions

assignment(member)

Returns the member's current partition assignment.

client_host(member)

Returns the client host.

client_id(member)

Returns the client ID.

from_describe_group_response(response)

Builds a Member from a DescribeGroups API response.

member_id(member)

Returns the member ID.

Types

Link to this type

partial_response()

View Source 
@type partial_response() :: %{
  :member_id => binary(),
  :client_id => binary(),
  :client_host => binary(),
  :member_metadata => term(),
  optional(:member_assignment) => map() | nil
}
Link to this type

t()

View Source 
@type t() :: %KafkaEx.Messages.ConsumerGroupDescription.Member{
  client_host: binary(),
  client_id: binary(),
  group_instance_id: binary() | nil,
  member_assignment:
    KafkaEx.Messages.ConsumerGroupDescription.Member.MemberAssignment.t() | nil,
  member_id: binary(),
  member_metadata: term()
}

Functions

Link to this function

assignment(member)

View Source 
@spec assignment(t()) ::
  KafkaEx.Messages.ConsumerGroupDescription.Member.MemberAssignment.t() | nil

Returns the member's current partition assignment.

Link to this function

client_host(member)

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

Returns the client host.

Link to this function

client_id(member)

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

Returns the client ID.

Link to this function

from_describe_group_response(response)

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

Builds a Member from a DescribeGroups API response.

Link to this function

member_id(member)

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

Returns the member ID.