org.apache.kafka.clients.admin

Class ListConsumerGroupsOptions

java.lang.Object

org.apache.kafka.clients.admin.AbstractOptions<ListConsumerGroupsOptions>

org.apache.kafka.clients.admin.ListConsumerGroupsOptions

@InterfaceStability.Evolving
public class ListConsumerGroupsOptions
extends AbstractOptions<ListConsumerGroupsOptions>

Options for Admin.listConsumerGroups(). The API of this class is evolving, see Admin for details.

Constructor Summary

Constructors

Constructor and Description
ListConsumerGroupsOptions()

Method Summary

Modifier and Type	Method and Description
ListConsumerGroupsOptions	inStates(Set<ConsumerGroupState> states) If states is set, only groups in these states will be returned by listConsumerGroups().
Set<ConsumerGroupState>	states() Returns the list of States that are requested or empty if no states have been specified.
Set<GroupType>	types() Returns the list of group types that are requested or empty if no types have been specified.
ListConsumerGroupsOptions	withTypes(Set<GroupType> types) If types is set, only groups of these types will be returned by listConsumerGroups().

Methods inherited from class org.apache.kafka.clients.admin.AbstractOptions

timeoutMs, timeoutMs

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListConsumerGroupsOptions

public ListConsumerGroupsOptions()

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.

withTypes

public ListConsumerGroupsOptions withTypes(Set<GroupType> types)

If types is set, only groups of these types will be returned by listConsumerGroups(). Otherwise, all groups are returned.

states

public Set<ConsumerGroupState> states()

Returns the list of States that are requested or empty if no states have been specified.

types

public Set<GroupType> types()

Returns the list of group types that are requested or empty if no types have been specified.