Class ConsumerGroupMetadata

java.lang.Object

org.apache.kafka.clients.consumer.ConsumerGroupMetadata

@Public
public class ConsumerGroupMetadata
extends Object

A metadata struct containing the consumer group information. Note: Any change to this class is considered public and requires a KIP.

Constructor Summary

Constructors

Constructor	Description
ConsumerGroupMetadata(String groupId)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.2, please use KafkaConsumer.groupMetadata() instead.
ConsumerGroupMetadata(String groupId, int generationId, String memberId, Optional<String> groupInstanceId)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.2, please use KafkaConsumer.groupMetadata() instead.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	generationId()	Returns the generation ID of the consumer group.
String	groupId()	Returns the consumer group ID.
Optional<String>	groupInstanceId()	Returns the group instance ID if this is a static member.
int	hashCode()
String	memberId()	Returns the member ID of this consumer.
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConsumerGroupMetadata

@Deprecated(since="4.2",
            forRemoval=true)
public ConsumerGroupMetadata(String groupId,
 int generationId,
 String memberId,
 Optional<String> groupInstanceId)

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

Since 4.2, please use KafkaConsumer.groupMetadata() instead. This class will be an interface in Kafka 5.0.

ConsumerGroupMetadata

@Deprecated(since="4.2",
            forRemoval=true)
public ConsumerGroupMetadata(String groupId)

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

Since 4.2, please use KafkaConsumer.groupMetadata() instead. This class will be an interface in Kafka 5.0.

Method Details

groupId

public String groupId()

Returns the consumer group ID.

Returns:

The group ID

generationId

public int generationId()

Returns the generation ID of the consumer group.

Returns:

The generation ID

memberId

public String memberId()

Returns the member ID of this consumer.

Returns:

The member ID

groupInstanceId

public Optional<String> groupInstanceId()

Returns the group instance ID if this is a static member.

Returns:

The group instance ID, or empty if this is a dynamic member

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object