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 for
Admin.listConsumerGroups()
.
The API of this class is evolving, see Admin
for details.-
Field Summary
Fields inherited from class org.apache.kafka.clients.admin.AbstractOptions
timeoutMs
-
Constructor Summary
Constructors Constructor Description ListConsumerGroupsOptions()
-
Method Summary
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 specifiedMethods inherited from class org.apache.kafka.clients.admin.AbstractOptions
timeoutMs, timeoutMs
-
Constructor Details
-
ListConsumerGroupsOptions
public ListConsumerGroupsOptions()
-
-
Method Details
-
inStates
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
Returns the list of States that are requested or empty if no states have been specified
-