Package org.apache.kafka.clients.admin

Class ConsumerGroupDescription

java.lang.Object

org.apache.kafka.clients.admin.ConsumerGroupDescription

public class ConsumerGroupDescription
extends Object

A detailed description of a single consumer group in the cluster.

Constructor Summary

Constructors

Constructor	Description
ConsumerGroupDescription(String groupId, boolean isSimpleConsumerGroup, Collection<MemberDescription> members, String partitionAssignor, ConsumerGroupState state, Node coordinator)	Deprecated. Since 4.0.
ConsumerGroupDescription(String groupId, boolean isSimpleConsumerGroup, Collection<MemberDescription> members, String partitionAssignor, ConsumerGroupState state, Node coordinator, Set<AclOperation> authorizedOperations)	Deprecated. Since 4.0.
ConsumerGroupDescription(String groupId, boolean isSimpleConsumerGroup, Collection<MemberDescription> members, String partitionAssignor, GroupType type, ConsumerGroupState state, Node coordinator, Set<AclOperation> authorizedOperations)	Deprecated. Since 4.0.
ConsumerGroupDescription(String groupId, boolean isSimpleConsumerGroup, Collection<MemberDescription> members, String partitionAssignor, GroupType type, GroupState groupState, Node coordinator, Set<AclOperation> authorizedOperations, Optional<Integer> groupEpoch, Optional<Integer> targetAssignmentEpoch)

Method Summary

Modifier and Type	Method	Description
Set<AclOperation>	authorizedOperations()	authorizedOperations for this group, or null if that information is not known.
Node	coordinator()	The consumer group coordinator, or null if the coordinator is not known.
boolean	equals(Object o)
Optional<Integer>	groupEpoch()	The epoch of the consumer group.
String	groupId()	The id of the consumer group.
GroupState	groupState()	The group state, or UNKNOWN if the state is too new for us to parse.
int	hashCode()
boolean	isSimpleConsumerGroup()	If consumer group is simple or not.
Collection<MemberDescription>	members()	A list of the members of the consumer group.
String	partitionAssignor()	The consumer group partition assignor.
ConsumerGroupState	state()	Deprecated. Since 4.0.
Optional<Integer>	targetAssignmentEpoch()	The epoch of the target assignment.
String	toString()
GroupType	type()	The group type (or the protocol) of this consumer group.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConsumerGroupDescription

@Deprecated
public ConsumerGroupDescription(String groupId,
 boolean isSimpleConsumerGroup,
 Collection<MemberDescription> members,
 String partitionAssignor,
 ConsumerGroupState state,
 Node coordinator)

Deprecated.

Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.

ConsumerGroupDescription

@Deprecated
public ConsumerGroupDescription(String groupId,
 boolean isSimpleConsumerGroup,
 Collection<MemberDescription> members,
 String partitionAssignor,
 ConsumerGroupState state,
 Node coordinator,
 Set<AclOperation> authorizedOperations)

Deprecated.

Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.

ConsumerGroupDescription

@Deprecated
public ConsumerGroupDescription(String groupId,
 boolean isSimpleConsumerGroup,
 Collection<MemberDescription> members,
 String partitionAssignor,
 GroupType type,
 ConsumerGroupState state,
 Node coordinator,
 Set<AclOperation> authorizedOperations)

Deprecated.

Since 4.0. Use ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional) instead.

ConsumerGroupDescription

public ConsumerGroupDescription(String groupId,
 boolean isSimpleConsumerGroup,
 Collection<MemberDescription> members,
 String partitionAssignor,
 GroupType type,
 GroupState groupState,
 Node coordinator,
 Set<AclOperation> authorizedOperations,
 Optional<Integer> groupEpoch,
 Optional<Integer> targetAssignmentEpoch)

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

groupId

public String groupId()

The id of the consumer group.

isSimpleConsumerGroup

public boolean isSimpleConsumerGroup()

If consumer group is simple or not.

members

public Collection<MemberDescription> members()

A list of the members of the consumer group.

partitionAssignor

public String partitionAssignor()

The consumer group partition assignor.

type

public GroupType type()

The group type (or the protocol) of this consumer group. It defaults to Classic if not provided by the server.

state

@Deprecated
public ConsumerGroupState state()

Deprecated.

Since 4.0. Use groupState() instead.

The consumer group state, or UNKNOWN if the state is too new for us to parse.

groupState

public GroupState groupState()

The group state, or UNKNOWN if the state is too new for us to parse.

coordinator

public Node coordinator()

The consumer group coordinator, or null if the coordinator is not known.

authorizedOperations

public Set<AclOperation> authorizedOperations()

authorizedOperations for this group, or null if that information is not known.

groupEpoch

public Optional<Integer> groupEpoch()

The epoch of the consumer group. The optional is set to an integer if it is a GroupType.CONSUMER group, and to empty if it is a GroupType.CLASSIC group.

targetAssignmentEpoch

public Optional<Integer> targetAssignmentEpoch()

The epoch of the target assignment. The optional is set to an integer if it is a GroupType.CONSUMER group, and to empty if it is a GroupType.CLASSIC group.

toString

public String toString()

Overrides:

toString in class Object