Class StreamsGroupDescription

java.lang.Object

org.apache.kafka.clients.admin.StreamsGroupDescription

@Evolving
@Public
public class StreamsGroupDescription
extends Object

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

Constructor Summary

Constructors

Constructor	Description
StreamsGroupDescription(String groupId, int groupEpoch, int targetAssignmentEpoch, int topologyEpoch, Collection<StreamsGroupSubtopologyDescription> subtopologies, Collection<StreamsGroupMemberDescription> members, GroupState groupState, Node coordinator, Set<AclOperation> authorizedOperations)	Deprecated, for removal: This API element is subject to removal in a future version. Since 4.4.
StreamsGroupDescription(String groupId, int groupEpoch, int targetAssignmentEpoch, int topologyEpoch, Collection<StreamsGroupSubtopologyDescription> subtopologies, Collection<StreamsGroupMemberDescription> members, GroupState groupState, Node coordinator, Set<AclOperation> authorizedOperations, Optional<StreamsGroupTopologyDescription> topologyDescription, StreamsGroupTopologyDescriptionStatus topologyDescriptionStatus, Optional<String> assignorName)

Method Summary

Modifier and Type	Method	Description
Optional<String>	assignorName()	The task assignor the coordinator will use for the next assignment computation.
Set<AclOperation>	authorizedOperations()	authorizedOperations for this group, or null if that information is not known.
Node	coordinator()	The group coordinator, or null if the coordinator is not known.
boolean	equals(Object o)
int	groupEpoch()	The epoch of the consumer group.
String	groupId()	The id of the streams group.
GroupState	groupState()	The state of the streams group, or UNKNOWN if the state is too new for us to parse.
int	hashCode()
Collection<StreamsGroupMemberDescription>	members()	A list of the members of the streams group.
Collection<StreamsGroupSubtopologyDescription>	subtopologies()	A list of the subtopologies in the streams group.
int	targetAssignmentEpoch()	The epoch of the target assignment.
Optional<StreamsGroupTopologyDescription>	topologyDescription()	The full topology description for this group, as recorded by the broker's topology description plugin.
StreamsGroupTopologyDescriptionStatus	topologyDescriptionStatus()	The status of the topology description for this group, paired with topologyDescription().
int	topologyEpoch()	The epoch of the currently used topology.
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StreamsGroupDescription

@Deprecated(since="4.4",
            forRemoval=true)
public StreamsGroupDescription(String groupId,
 int groupEpoch,
 int targetAssignmentEpoch,
 int topologyEpoch,
 Collection<StreamsGroupSubtopologyDescription> subtopologies,
 Collection<StreamsGroupMemberDescription> members,
 GroupState groupState,
 Node coordinator,
 Set<AclOperation> authorizedOperations)

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

Since 4.4. Use StreamsGroupDescription(String, int, int, int, Collection, Collection, GroupState, Node, Set, Optional, StreamsGroupTopologyDescriptionStatus, Optional) instead.

StreamsGroupDescription

public StreamsGroupDescription(String groupId,
 int groupEpoch,
 int targetAssignmentEpoch,
 int topologyEpoch,
 Collection<StreamsGroupSubtopologyDescription> subtopologies,
 Collection<StreamsGroupMemberDescription> members,
 GroupState groupState,
 Node coordinator,
 Set<AclOperation> authorizedOperations,
 Optional<StreamsGroupTopologyDescription> topologyDescription,
 StreamsGroupTopologyDescriptionStatus topologyDescriptionStatus,
 Optional<String> assignorName)

Method Details

groupId

public String groupId()

The id of the streams group.

groupEpoch

public int groupEpoch()

The epoch of the consumer group.

targetAssignmentEpoch

public int targetAssignmentEpoch()

The epoch of the target assignment.

topologyEpoch

public int topologyEpoch()

The epoch of the currently used topology.

members

public Collection<StreamsGroupMemberDescription> members()

A list of the members of the streams group.

subtopologies

public Collection<StreamsGroupSubtopologyDescription> subtopologies()

A list of the subtopologies in the streams group.

groupState

public GroupState groupState()

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

coordinator

public Node coordinator()

The 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.

topologyDescription

public Optional<StreamsGroupTopologyDescription> topologyDescription()

The full topology description for this group, as recorded by the broker's topology description plugin. Present if and only if topologyDescriptionStatus() is AVAILABLE.

topologyDescriptionStatus

public StreamsGroupTopologyDescriptionStatus topologyDescriptionStatus()

The status of the topology description for this group, paired with topologyDescription().

assignorName

public Optional<String> assignorName()

The task assignor the coordinator will use for the next assignment computation. May differ from the assignor that computed the current assignment. Empty if the broker is too old to report it.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object