Package org.apache.kafka.clients.admin

Class ListGroupsOptions

java.lang.Object

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

org.apache.kafka.clients.admin.ListGroupsOptions

@Evolving
public class ListGroupsOptions
extends AbstractOptions<ListGroupsOptions>

Options for Admin.listGroups().

The API of this class is evolving, see Admin for details.

Constructor Summary

Constructors

Constructor	Description
ListGroupsOptions()

Method Summary

Modifier and Type	Method	Description
static ListGroupsOptions	forConsumerGroups()	Only consumer groups will be returned by listGroups().
static ListGroupsOptions	forShareGroups()	Only share groups will be returned by listGroups().
static ListGroupsOptions	forStreamsGroups()	Only streams groups will be returned by listGroups().
Set<GroupState>	groupStates()	Returns the list of group states that are requested or empty if no states have been specified.
ListGroupsOptions	inGroupStates(Set<GroupState> groupStates)	If groupStates is set, only groups in these states will be returned by listGroups().
Set<String>	protocolTypes()	Returns the list of protocol types that are requested or empty if no protocol types have been specified.
Set<GroupType>	types()	Returns the list of group types that are requested or empty if no types have been specified.
ListGroupsOptions	withProtocolTypes(Set<String> protocolTypes)	If protocol types is set, only groups of these protocol types will be returned by listGroups().
ListGroupsOptions	withTypes(Set<GroupType> types)	If types is set, only groups of these types will be returned by listGroups().

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

ListGroupsOptions

public ListGroupsOptions()

Method Details

forConsumerGroups

public static ListGroupsOptions forConsumerGroups()

Only consumer groups will be returned by listGroups(). This operation sets filters on group type and protocol type which select consumer groups.

forShareGroups

public static ListGroupsOptions forShareGroups()

Only share groups will be returned by listGroups(). This operation sets a filter on group type which select share groups.

forStreamsGroups

public static ListGroupsOptions forStreamsGroups()

Only streams groups will be returned by listGroups(). This operation sets a filter on group type which select streams groups.

inGroupStates

public ListGroupsOptions 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.

withProtocolTypes

public ListGroupsOptions withProtocolTypes(Set<String> protocolTypes)

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

withTypes

public ListGroupsOptions withTypes(Set<GroupType> types)

If types is set, only groups of these types will be returned by listGroups(). 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.

protocolTypes

public Set<String> protocolTypes()

Returns the list of protocol types that are requested or empty if no protocol types 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.