Package 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	Description
default String	comment()
String	name()
default Map<String,String>	properties()
default SupportsPolicies	supportsPolicies()
default SupportsRoles	supportsRoles()
default SupportsTags	supportsTags()

Methods inherited from interface org.apache.gravitino.Auditable

auditInfo

Method Details

name

String name()

Returns:

Name of the topic

comment

@Nullable
default String comment()

Returns:

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

properties

default Map<String,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:

UnsupportedOperationException - if the topic does not support tag operations.

supportsPolicies

default SupportsPolicies supportsPolicies()

Returns:

the SupportsPolicies if the topic supports policy operations.

Throws:

UnsupportedOperationException - if the topic does not support policy operations.

supportsRoles

default SupportsRoles supportsRoles()

Returns:

the SupportsRoles if the topic supports role operations.

Throws:

UnsupportedOperationException - if the topic does not support role operations.