Package org.apache.kafka.clients.admin
Class ListConsumerGroupsOptions
- java.lang.Object
-
- org.apache.kafka.clients.admin.AbstractOptions<ListConsumerGroupsOptions>
-
- org.apache.kafka.clients.admin.ListConsumerGroupsOptions
-
@Evolving public class ListConsumerGroupsOptions extends AbstractOptions<ListConsumerGroupsOptions>
Options forAdmin.listConsumerGroups()
. The API of this class is evolving, seeAdmin
for details.
-
-
Field Summary
-
Fields inherited from class org.apache.kafka.clients.admin.AbstractOptions
timeoutMs
-
-
Constructor Summary
Constructors Constructor Description ListConsumerGroupsOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListConsumerGroupsOptions
inStates(Set<ConsumerGroupState> states)
If states is set, only groups in these states will be returned by listConsumerGroups() Otherwise, all groups are returned.Set<ConsumerGroupState>
states()
Returns the list of States that are requested or empty if no states have been specified-
Methods inherited from class org.apache.kafka.clients.admin.AbstractOptions
timeoutMs, timeoutMs
-
-
-
-
Method Detail
-
inStates
public ListConsumerGroupsOptions inStates(Set<ConsumerGroupState> states)
If states is set, only groups in these states will be returned by listConsumerGroups() Otherwise, all groups are returned. This operation is supported by brokers with version 2.6.0 or later.
-
states
public Set<ConsumerGroupState> states()
Returns the list of States that are requested or empty if no states have been specified
-
-