org.apache.gravitino.messaging

Interface Topic

All Superinterfaces:

Auditable

All Known Implementing Classes:

TopicDTO

@Evolving
public interface Topic
extends Auditable

An interface representing a topic under a schema Namespace. A topic is a message queue that is managed by Apache Gravitino. Users can create/drop/alter a topic on the Message Queue system like Apache Kafka, Apache Pulsar, etc.

Topic defines the basic properties of a topic object. A catalog implementation with TopicCatalog should implement this interface.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	comment()
java.lang.String	name()
default java.util.Map<java.lang.String,java.lang.String>	properties()
default SupportsRoles	supportsRoles()
default SupportsTags	supportsTags()

Methods inherited from interface org.apache.gravitino.Auditable

auditInfo

Method Detail

name

java.lang.String name()

Returns:

Name of the topic

comment

@Nullable
default java.lang.String comment()

Returns:

The comment of the topic object. Null is returned if no comment is set.

properties

default java.util.Map<java.lang.String,java.lang.String> properties()

Returns:

The properties of the topic object. Empty map is returned if no properties are set.

supportsTags

default SupportsTags supportsTags()

Returns:

the SupportsTags if the topic supports tag operations.

Throws:

java.lang.UnsupportedOperationException - if the topic does not support tag operations.

supportsRoles

default SupportsRoles supportsRoles()

Returns:

the SupportsRoles if the topic supports role operations.

Throws:

java.lang.UnsupportedOperationException - if the topic does not support role operations.