Class MemberDescription

java.lang.Object

org.apache.kafka.clients.admin.MemberDescription

@Public
public class MemberDescription
extends Object

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

Constructor Summary

Constructors

Constructor	Description
MemberDescription(String memberId, String clientId, String host, MemberAssignment assignment)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.0.
MemberDescription(String memberId, Optional<String> groupInstanceId, String clientId, String host, MemberAssignment assignment)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.0.
MemberDescription(String memberId, Optional<String> groupInstanceId, String clientId, String host, MemberAssignment assignment, Optional<MemberAssignment> targetAssignment)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.0.
MemberDescription(String memberId, Optional<String> groupInstanceId, String clientId, String host, MemberAssignment assignment, Optional<MemberAssignment> targetAssignment, Optional<Integer> memberEpoch, Optional<Boolean> upgraded)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.2.
MemberDescription(String memberId, Optional<String> groupInstanceId, Optional<String> rackId, String clientId, String host, MemberAssignment assignment, Optional<MemberAssignment> targetAssignment, Optional<Integer> memberEpoch, Optional<Boolean> upgraded)

Method Summary

Modifier and Type	Method	Description
MemberAssignment	assignment()	The assignment of the group member.
String	clientId()	The client id of the group member.
String	consumerId()	The consumer id of the group member.
boolean	equals(Object o)
Optional<String>	groupInstanceId()	The instance id of the group member.
int	hashCode()
String	host()	The host where the group member is running.
Optional<Integer>	memberEpoch()	The epoch of the group member.
Optional<String>	rackId()	The rack id of the group member.
Optional<MemberAssignment>	targetAssignment()	The target assignment of the member.
String	toString()
Optional<Boolean>	upgraded()	The flag indicating whether a member within a GroupType.CONSUMER group uses the GroupType.CONSUMER protocol.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MemberDescription

public MemberDescription(String memberId,
 Optional<String> groupInstanceId,
 Optional<String> rackId,
 String clientId,
 String host,
 MemberAssignment assignment,
 Optional<MemberAssignment> targetAssignment,
 Optional<Integer> memberEpoch,
 Optional<Boolean> upgraded)

MemberDescription

@Deprecated(since="4.2",
            forRemoval=true)
public MemberDescription(String memberId,
 Optional<String> groupInstanceId,
 String clientId,
 String host,
 MemberAssignment assignment,
 Optional<MemberAssignment> targetAssignment,
 Optional<Integer> memberEpoch,
 Optional<Boolean> upgraded)

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

Since 4.2. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.

MemberDescription

@Deprecated(since="4.0",
            forRemoval=true)
public MemberDescription(String memberId,
 Optional<String> groupInstanceId,
 String clientId,
 String host,
 MemberAssignment assignment,
 Optional<MemberAssignment> targetAssignment)

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

Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.

MemberDescription

@Deprecated(since="4.0",
            forRemoval=true)
public MemberDescription(String memberId,
 Optional<String> groupInstanceId,
 String clientId,
 String host,
 MemberAssignment assignment)

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

Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.

MemberDescription

@Deprecated(since="4.0",
            forRemoval=true)
public MemberDescription(String memberId,
 String clientId,
 String host,
 MemberAssignment assignment)

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

Since 4.0. Use MemberDescription(String, Optional, Optional, String, String, MemberAssignment, Optional, Optional, Optional) instead.

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

consumerId

public String consumerId()

The consumer id of the group member.

groupInstanceId

public Optional<String> groupInstanceId()

The instance id of the group member.

rackId

public Optional<String> rackId()

The rack id of the group member.

It is only available for consumer groups using the new consumer group protocol (group.protocol=consumer).

clientId

public String clientId()

The client id of the group member.

host

public String host()

The host where the group member is running.

assignment

public MemberAssignment assignment()

The assignment of the group member. Provided for both classic group and consumer group.

targetAssignment

public Optional<MemberAssignment> targetAssignment()

The target assignment of the member. Provided only for consumer group.

memberEpoch

public Optional<Integer> memberEpoch()

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

upgraded

public Optional<Boolean> upgraded()

The flag indicating whether a member within a GroupType.CONSUMER group uses the GroupType.CONSUMER protocol. The optional is set to true if it does, to false if it does not, and to empty if it is unknown or if the group is a GroupType.CLASSIC group.

toString

public String toString()

Overrides:

toString in class Object