Package org.apache.kafka.clients.admin

Class DescribeTopicsResult

java.lang.Object

org.apache.kafka.clients.admin.DescribeTopicsResult

@Evolving
public class DescribeTopicsResult
extends Object

The result of the Admin.describeTopics(Collection) call. The API of this class is evolving, see Admin for details.

Method Summary

Modifier and Type	Method	Description
KafkaFuture<Map<String,TopicDescription>>	all()	Deprecated. Since 3.1.0 use allTopicNames() instead
KafkaFuture<Map<Uuid,TopicDescription>>	allTopicIds()
KafkaFuture<Map<String,TopicDescription>>	allTopicNames()
static DescribeTopicsResult	ofTopicIds(Map<Uuid,KafkaFuture<TopicDescription>> topicIdFutures)
static DescribeTopicsResult	ofTopicNames(Map<String,KafkaFuture<TopicDescription>> nameFutures)
Map<Uuid,KafkaFuture<TopicDescription>>	topicIdValues()	Use when Admin.describeTopics(TopicCollection, DescribeTopicsOptions) used a TopicIdCollection
Map<String,KafkaFuture<TopicDescription>>	topicNameValues()	Use when Admin.describeTopics(TopicCollection, DescribeTopicsOptions) used a TopicNameCollection
Map<String,KafkaFuture<TopicDescription>>	values()	Deprecated. Since 3.1.0 use topicNameValues() instead

Methods inherited from class java.lang.Object

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

Method Detail

ofTopicIds

public static DescribeTopicsResult ofTopicIds(Map<Uuid,KafkaFuture<TopicDescription>> topicIdFutures)

ofTopicNames

public static DescribeTopicsResult ofTopicNames(Map<String,KafkaFuture<TopicDescription>> nameFutures)

topicIdValues

public Map<Uuid,KafkaFuture<TopicDescription>> topicIdValues()

Use when Admin.describeTopics(TopicCollection, DescribeTopicsOptions) used a TopicIdCollection

Returns:

a map from topic IDs to futures which can be used to check the status of individual topics if the request used topic IDs, otherwise return null.

topicNameValues

public Map<String,KafkaFuture<TopicDescription>> topicNameValues()

Use when Admin.describeTopics(TopicCollection, DescribeTopicsOptions) used a TopicNameCollection

Returns:

a map from topic names to futures which can be used to check the status of individual topics if the request used topic names, otherwise return null.

values

@Deprecated
public Map<String,KafkaFuture<TopicDescription>> values()

Deprecated.

Since 3.1.0 use topicNameValues() instead

Returns:

a map from topic names to futures which can be used to check the status of individual topics if the request used topic names, otherwise return null.

all

@Deprecated
public KafkaFuture<Map<String,TopicDescription>> all()

Deprecated.

Since 3.1.0 use allTopicNames() instead

Returns:

A future map from topic names to descriptions which can be used to check the status of individual description if the describe topic request used topic names, otherwise return null, this request succeeds only if all the topic descriptions succeed

allTopicNames

public KafkaFuture<Map<String,TopicDescription>> allTopicNames()

Returns:

A future map from topic names to descriptions which can be used to check the status of individual description if the describe topic request used topic names, otherwise return null, this request succeeds only if all the topic descriptions succeed

allTopicIds

public KafkaFuture<Map<Uuid,TopicDescription>> allTopicIds()

Returns:

A future map from topic ids to descriptions which can be used to check the status of individual description if the describe topic request used topic ids, otherwise return null, this request succeeds only if all the topic descriptions succeed