org.apache.kafka.clients.admin

Class TopicDescription

java.lang.Object

org.apache.kafka.clients.admin.TopicDescription

public class TopicDescription
extends java.lang.Object

A detailed description of a single topic in the cluster.

Constructor Summary

Constructors

Constructor and Description
TopicDescription(java.lang.String name, boolean internal, java.util.List<TopicPartitionInfo> partitions) Create an instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	isInternal() Whether the topic is internal to Kafka.
java.lang.String	name() The name of the topic.
java.util.List<TopicPartitionInfo>	partitions() A list of partitions where the index represents the partition id and the element contains leadership and replica information for that partition.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TopicDescription

public TopicDescription(java.lang.String name,
                        boolean internal,
                        java.util.List<TopicPartitionInfo> partitions)

Create an instance with the specified parameters.

Parameters:

name - The topic name

internal - Whether the topic is internal to Kafka

partitions - A list of partitions where the index represents the partition id and the element contains leadership and replica information for that partition.

Method Detail

name

public java.lang.String name()

The name of the topic.

isInternal

public boolean isInternal()

Whether the topic is internal to Kafka. An example of an internal topic is the offsets and group management topic: __consumer_offsets.

partitions

public java.util.List<TopicPartitionInfo> partitions()

A list of partitions where the index represents the partition id and the element contains leadership and replica information for that partition.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object