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.

  • Constructor Details

  • Method Details

    • topicIdValues

      public Map<org.apache.kafka.common.Uuid,org.apache.kafka.common.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,org.apache.kafka.common.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,org.apache.kafka.common.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 org.apache.kafka.common.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 org.apache.kafka.common.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 org.apache.kafka.common.KafkaFuture<Map<org.apache.kafka.common.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