Package org.apache.kafka.clients.admin

Class ListConsumerGroupsOptions

java.lang.Object

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

org.apache.kafka.clients.admin.ListConsumerGroupsOptions

public class ListConsumerGroupsOptions
extends AbstractOptions<ListConsumerGroupsOptions>

Options for Admin.listConsumerGroups().

Constructor Summary

Constructors

Constructor	Description
ListConsumerGroupsOptions()

Method Summary

Modifier and Type	Method	Description
Set<GroupState>	groupStates()	Returns the list of group states that are requested or empty if no states have been specified.
ListConsumerGroupsOptions	inGroupStates(Set<GroupState> groupStates)	If groupStates is set, only groups in these states will be returned by listGroups().
ListConsumerGroupsOptions	inStates(Set<ConsumerGroupState> states)	Deprecated. Since 4.0.
Set<ConsumerGroupState>	states()	Deprecated. Since 4.0.
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 Details

ListConsumerGroupsOptions

public ListConsumerGroupsOptions()

Method Details

inGroupStates

public ListConsumerGroupsOptions inGroupStates(Set<GroupState> groupStates)

If groupStates is set, only groups in these states will be returned by listGroups(). Otherwise, all groups are returned. This operation is supported by brokers with version 2.6.0 or later.

inStates

@Deprecated
public ListConsumerGroupsOptions inStates(Set<ConsumerGroupState> states)

Deprecated.

Since 4.0. Use inGroupStates(Set) instead.

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.

groupStates

public Set<GroupState> groupStates()

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

states

@Deprecated
public Set<ConsumerGroupState> states()

Deprecated.

Since 4.0. Use inGroupStates(Set) instead.

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.