Package org.apache.kafka.clients.admin

Class DescribeClusterResult

java.lang.Object

org.apache.kafka.clients.admin.DescribeClusterResult

@Evolving
public class DescribeClusterResult
extends java.lang.Object

The result of the AdminClient.describeCluster() call. The API of this class is evolving, see AdminClient for details.

Constructor Summary

Constructors

Constructor	Description
DescribeClusterResult(KafkaFuture<java.util.Collection<Node>> nodes, KafkaFuture<Node> controller, KafkaFuture<java.lang.String> clusterId)

Method Summary

Modifier and Type	Method	Description
KafkaFuture<java.lang.String>	clusterId()	Returns a future which yields the current cluster id.
KafkaFuture<Node>	controller()	Returns a future which yields the current controller id.
KafkaFuture<java.util.Collection<Node>>	nodes()	Returns a future which yields a collection of nodes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescribeClusterResult

public DescribeClusterResult(KafkaFuture<java.util.Collection<Node>> nodes,
                             KafkaFuture<Node> controller,
                             KafkaFuture<java.lang.String> clusterId)

Method Detail

nodes

public KafkaFuture<java.util.Collection<Node>> nodes()

Returns a future which yields a collection of nodes.

controller

public KafkaFuture<Node> controller()

Returns a future which yields the current controller id. Note that this may yield null, if the controller ID is not yet known.

clusterId

public KafkaFuture<java.lang.String> clusterId()

Returns a future which yields the current cluster id. The future value will be non-null if the broker version is 0.10.1.0 or higher and null otherwise.