Class ConsumerGroupListing

java.lang.Object

org.apache.kafka.clients.admin.ConsumerGroupListing

@Deprecated(since="4.1",
            forRemoval=true)
public class ConsumerGroupListing
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

Since 4.1. Use Admin.listGroups(ListGroupsOptions) and GroupListing instead.

A listing of a consumer group in the cluster.

Constructor Summary

Constructors

Constructor	Description
ConsumerGroupListing(String groupId, boolean isSimpleConsumerGroup)	Deprecated, for removal: This API element is subject to removal in a future version. Create an instance with the specified parameters.
ConsumerGroupListing(String groupId, boolean isSimpleConsumerGroup, Optional<ConsumerGroupState> state)	Deprecated. Since 4.0.
ConsumerGroupListing(String groupId, boolean isSimpleConsumerGroup, Optional<ConsumerGroupState> state, Optional<GroupType> type)	Deprecated. Since 4.0.
ConsumerGroupListing(String groupId, Optional<GroupState> groupState, boolean isSimpleConsumerGroup)	Deprecated, for removal: This API element is subject to removal in a future version. Create an instance with the specified parameters.
ConsumerGroupListing(String groupId, Optional<GroupState> groupState, Optional<GroupType> type, boolean isSimpleConsumerGroup)	Deprecated, for removal: This API element is subject to removal in a future version. Create an instance with the specified parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Deprecated, for removal: This API element is subject to removal in a future version.
String	groupId()	Deprecated, for removal: This API element is subject to removal in a future version. Consumer Group Id
Optional<GroupState>	groupState()	Deprecated, for removal: This API element is subject to removal in a future version. Group state
int	hashCode()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isSimpleConsumerGroup()	Deprecated, for removal: This API element is subject to removal in a future version. If Consumer Group is simple or not.
Optional<ConsumerGroupState>	state()	Deprecated. Since 4.0.
String	toString()	Deprecated, for removal: This API element is subject to removal in a future version.
Optional<GroupType>	type()	Deprecated, for removal: This API element is subject to removal in a future version. The type of the consumer group.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConsumerGroupListing

public ConsumerGroupListing(String groupId,
 boolean isSimpleConsumerGroup)

Deprecated, for removal: This API element is subject to removal in a future version.

Create an instance with the specified parameters.

Parameters:

groupId - Group Id.

isSimpleConsumerGroup - If consumer group is simple or not.

ConsumerGroupListing

@Deprecated
public ConsumerGroupListing(String groupId,
 boolean isSimpleConsumerGroup,
 Optional<ConsumerGroupState> state)

Deprecated.

Since 4.0. Use ConsumerGroupListing(String, Optional, boolean) instead.

Create an instance with the specified parameters.

Parameters:

groupId - Group Id.

isSimpleConsumerGroup - If consumer group is simple or not.

state - The state of the consumer group.

ConsumerGroupListing

@Deprecated
public ConsumerGroupListing(String groupId,
 boolean isSimpleConsumerGroup,
 Optional<ConsumerGroupState> state,
 Optional<GroupType> type)

Deprecated.

Since 4.0. Use ConsumerGroupListing(String, Optional, Optional, boolean) instead.

Create an instance with the specified parameters.

Parameters:

groupId - Group Id.

isSimpleConsumerGroup - If consumer group is simple or not.

state - The state of the consumer group.

type - The type of the consumer group.

ConsumerGroupListing

public ConsumerGroupListing(String groupId,
 Optional<GroupState> groupState,
 boolean isSimpleConsumerGroup)

Deprecated, for removal: This API element is subject to removal in a future version.

Create an instance with the specified parameters.

Parameters:

groupId - Group Id.

groupState - The state of the consumer group.

isSimpleConsumerGroup - If consumer group is simple or not.

ConsumerGroupListing

public ConsumerGroupListing(String groupId,
 Optional<GroupState> groupState,
 Optional<GroupType> type,
 boolean isSimpleConsumerGroup)

Deprecated, for removal: This API element is subject to removal in a future version.

Create an instance with the specified parameters.

Parameters:

groupId - Group Id.

groupState - The state of the consumer group.

type - The type of the consumer group.

isSimpleConsumerGroup - If consumer group is simple or not.

Method Details

groupId

public String groupId()

Deprecated, for removal: This API element is subject to removal in a future version.

Consumer Group Id

isSimpleConsumerGroup

public boolean isSimpleConsumerGroup()

Deprecated, for removal: This API element is subject to removal in a future version.

If Consumer Group is simple or not.

groupState

public Optional<GroupState> groupState()

Deprecated, for removal: This API element is subject to removal in a future version.

Group state

state

@Deprecated
public Optional<ConsumerGroupState> state()

Deprecated.

Since 4.0. Use groupState() instead.

Consumer Group state

type

public Optional<GroupType> type()

Deprecated, for removal: This API element is subject to removal in a future version.

The type of the consumer group.

Returns:

An Optional containing the type, if available.

toString

public String toString()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

toString in class Object

hashCode

public int hashCode()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

equals in class Object