Package com.atlan.model.typedefs

Class AtlanTagDef

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.typedefs.TypeDef
com.atlan.model.typedefs.AtlanTagDef
All Implemented Interfaces:
Serializable
public class AtlanTagDef extends TypeDef
Structural definition of an Atlan tag.
See Also:

  • Constructor Details

  • Method Details

    • creator

      public static AtlanTagDef.AtlanTagDefBuilder<?,?> creator(String displayName, AtlanTagColor color)
      Builds the minimal object necessary to create an Atlan tag definition, using the default tag icon.
      Parameters:
      displayName - the human-readable name for the Atlan tag
      color - the color to use for the Atlan tag
      Returns:
      the minimal request necessary to create the Atlan tag typedef, as a builder

    • creator

      public static AtlanTagDef.AtlanTagDefBuilder<?,?> creator(String displayName, AtlanIcon icon, AtlanTagColor color)
      Builds the minimal object necessary to create an Atlan tag definition.
      Parameters:
      displayName - the human-readable name for the Atlan tag
      icon - the built-in icon to use for the Atlan tag
      color - the color to use for the Atlan tag
      Returns:
      the minimal request necessary to create the Atlan tag typedef, as a builder

    • creator

      public static AtlanTagDef.AtlanTagDefBuilder<?,?> creator(String displayName, String url) throws AtlanException
      Builds the minimal object necessary to create an Atlan tag definition.
      Parameters:
      displayName - the human-readable name for the Atlan tag
      url - URL to an image to use for the Atlan tag
      Returns:
      the minimal request necessary to create the Atlan tag typedef, as a builder
      Throws:
      AtlanException - on any issues uploading the image from the provided URL

    • creator

      public static AtlanTagDef.AtlanTagDefBuilder<?,?> creator(String displayName, AtlanTagOptions options) throws AtlanException
      Builds the minimal object necessary to create an Atlan tag definition.
      Parameters:
      displayName - the human-readable name for the Atlan tag
      options - to use when creating the Atlan tag
      Returns:
      the minimal request necessary to create the Atlan tag typedef, as a builder
      Throws:
      AtlanException - on any issues uploading the image from the provided URL

    • create

      public AtlanTagDef create(AtlanClient client) throws AtlanException
      Create this Atlan tag definition in Atlan.
      Parameters:
      client - connectivity to an Atlan tenant
      Returns:
      the result of the creation, or null if the creation failed
      Throws:
      AtlanException - on any API communication issues

    • purge

      public static void purge(String displayName) throws AtlanException
      Hard-deletes (purges) an Atlan tag by its human-readable name. This operation is irreversible. If there are any existing Atlan tag instances, this operation will fail.
      Parameters:
      displayName - human-readable name of the Atlan tag
      Throws:
      AtlanException - on any error during the API invocation

    • purge

      public static void purge(AtlanClient client, String displayName) throws AtlanException
      Hard-deletes (purges) an Atlan tag by its human-readable name. This operation is irreversible. If there are any existing Atlan tag instances, this operation will fail.
      Parameters:
      client - connectivity to the Atlan tenant from which the Atlan tag should be purged
      displayName - human-readable name of the Atlan tag
      client - connectivity to an Atlan tenant
      Throws:
      AtlanException - on any error during the API invocation

    • builder

      public static AtlanTagDef.AtlanTagDefBuilder<?,?> builder()

    • toBuilder

      public AtlanTagDef.AtlanTagDefBuilder<?,?> toBuilder()

    • getOptions

      public AtlanTagOptions getOptions()
      Options that describe the Atlan tag.

    • getSuperTypes

      public List<String> getSuperTypes()
      Unused.

    • getEntityTypes

      public List<String> getEntityTypes()
      List of the types of entities that the Atlan tag can be applied to.

    • getSubTypes

      public List<String> getSubTypes()
      Unused.

    • getSkipDisplayNameUniquenessCheck

      public Boolean getSkipDisplayNameUniquenessCheck()
      TBC

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class TypeDef

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class TypeDef

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class TypeDef

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class TypeDef

    • getCategory

      public AtlanTypeCategory getCategory()
      Fixed category for Atlan tag typedefs.
      Overrides:
      getCategory in class TypeDef