Module groups 

Consumer-group admin APIs: AdminClient::list_groups and AdminClient::list_consumer_group_offsets.

These wrap the ListGroups (api_key=16), OffsetCommit (api_key=8) and OffsetFetch (api_key=9) RPCs.

ListGroups fan-out

A broker lists only the groups that it coordinates. AdminClient::list_groups sends ListGroups to every broker in the metadata and merges the answers, as Apache Kafka’s KafkaAdminClient.listGroups does.

OffsetCommit version note

AdminClient::alter_consumer_group_offsets sends OffsetCommit at v9 or lower, where the request names each topic. Apache Kafka’s AlterConsumerGroupOffsetsHandler builds its request with OffsetCommitRequest.Builder.forTopicNames, which caps the version at 9.

OffsetFetch version note

AdminClient::list_consumer_group_offsets sends OffsetFetch at v2 to v9, where the response names each topic. Apache Kafka’s ListConsumerGroupOffsetsHandler builds its request with OffsetFetchRequest.Builder.forTopicNames, which caps the version at 9.

OffsetFetch retries

AdminClient::list_consumer_group_offsets retries the coordinator error codes as Apache Kafka’s ListConsumerGroupOffsetsHandler.handleGroupError does, until Kafka’s default default.api.timeout.ms (60 s) elapses.

Structs

ConsumerGroupOffsetOutcome

GroupListing

One group of AdminClient::list_groups, as Apache Kafka’s GroupListing holds it.

ListGroupsError

The failure of ListGroups on one broker.

ListGroupsOptions

The options of AdminClient::list_groups, as Apache Kafka’s ListGroupsOptions holds them. An empty set does not filter.

ListGroupsOptionsBuilder

Use builder syntax to set the inputs and finish with build().

ListGroupsResult

The result of AdminClient::list_groups, as Apache Kafka’s ListGroupsResult holds it.

MemberToRemove

One member to remove, as Apache Kafka’s MemberToRemove names it: by its group.instance.id.

RemoveMembersOptions

The options of AdminClient::remove_members_from_consumer_group, as Apache Kafka’s RemoveMembersFromConsumerGroupOptions holds them.

RemoveMembersOptionsBuilder

Use builder syntax to set the inputs and finish with build().

RemovedMember

One member of a LeaveGroup answer, as the MemberIdentity keys of Kafka’s RemoveMembersFromConsumerGroupHandler result name it.

RemovedMembers

The result of AdminClient::remove_members_from_consumer_group, as Apache Kafka’s RemoveMembersFromConsumerGroupResult holds it.

Enums

GroupState

The state of a group, as Apache Kafka’s GroupState names it.

GroupType

The type of a group, as Apache Kafka’s GroupType names it.

Type Aliases

GroupOffsets

Offsets keyed by topic name and partition.