org.apache.kafka.clients.admin

Class TopicListing

java.lang.Object

org.apache.kafka.clients.admin.TopicListing

public class TopicListing
extends Object

A listing of a topic in the cluster.

Constructor Summary

Constructors

Constructor and Description
TopicListing(String name, boolean internal) Deprecated. Since 3.0 use TopicListing(String, Uuid, boolean, TopicType) instead
TopicListing(String name, Uuid topicId, boolean internal) For testing purposes only Create an instance with the specified parameters.
TopicListing(String name, Uuid topicId, boolean internal, TopicType topicType) Create an instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	isInternal() Whether the topic is internal to Kafka.
String	name() The name of the topic.
Uuid	topicId() The id of the topic.
TopicType	topicType() The type of the topic.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TopicListing

@Deprecated
public TopicListing(String name,
                                boolean internal)

Deprecated. Since 3.0 use TopicListing(String, Uuid, boolean, TopicType) instead

Create an instance with the specified parameters.

Parameters:

name - The topic name

internal - Whether the topic is internal to Kafka

TopicListing

public TopicListing(String name,
                    Uuid topicId,
                    boolean internal)

For testing purposes only Create an instance with the specified parameters.

Parameters:

name - The topic name

topicId - The topic id.

internal - Whether the topic is internal to Kafka

TopicListing

public TopicListing(String name,
                    Uuid topicId,
                    boolean internal,
                    TopicType topicType)

Create an instance with the specified parameters.

Parameters:

name - The topic name

topicId - The topic id.

internal - Whether the topic is internal to Kafka

topicType - The topic type. UNKNOWN if not supported by the broker.

Method Detail

topicId

public Uuid topicId()

The id of the topic.

name

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

topicType

public TopicType topicType()

The type of the topic.

toString

public String toString()

Overrides:

toString in class Object