org.apache.gravitino.tag

Interface Tag

All Superinterfaces:

Auditable

All Known Implementing Classes:

TagDTO

@Evolving
public interface Tag
extends Auditable

The interface of a tag. A tag is a label that can be attached to a catalog, schema, table, fileset, topic, or column. It can be used to categorize, classify, or annotate these objects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Tag.AssociatedObjects The interface of the associated objects of the tag.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_COLOR A reserved property to specify the color of the tag.

Method Summary

Modifier and Type	Method and Description
default Tag.AssociatedObjects	associatedObjects()
java.lang.String	comment()
java.util.Optional<java.lang.Boolean>	inherited() Check if the tag is inherited from a parent object or not.
java.lang.String	name()
java.util.Map<java.lang.String,java.lang.String>	properties()

Methods inherited from interface org.apache.gravitino.Auditable

auditInfo

Field Detail

PROPERTY_COLOR

static final java.lang.String PROPERTY_COLOR

A reserved property to specify the color of the tag. The color is a string of hex code that represents the color of the tag. The color is used to visually distinguish the tag from other tags.

See Also:

Constant Field Values

Method Detail

name

java.lang.String name()

Returns:

The name of the tag.

comment

java.lang.String comment()

Returns:

The comment of the tag.

properties

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

Returns:

The properties of the tag.

inherited

java.util.Optional<java.lang.Boolean> inherited()

Check if the tag is inherited from a parent object or not. If the tag is inherited, it will return true, if it is owned by the object itself, it will return false.

Note. The return value is optional, only when the tag is associated with an object, and called from the object, the return value will be present. Otherwise, it will be empty.

Returns:

True if the tag is inherited, false if it is owned by the object itself. Empty if the tag is not associated with any object.

associatedObjects

default Tag.AssociatedObjects associatedObjects()

Returns:

The associated objects of the tag.