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

  • Field Details

    • PROPERTY_COLOR

      static final 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:

  • Method Details

    • name

      String name()
      Returns:
      The name of the tag.

    • comment

      String comment()
      Returns:
      The comment of the tag.

    • properties

      Map<String,String> properties()
      Returns:
      The properties of the tag.

    • inherited

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