Package com.atlan.model.typedefs

Class AtlanTagOptions

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.typedefs.AtlanTagOptions
All Implemented Interfaces:
Serializable
public class AtlanTagOptions extends AtlanObject
Options that can be defined for an Atlan tag.
See Also:

  • Constructor Details

  • Method Details

    • of

      public static AtlanTagOptions of(AtlanTagColor color)
      Provide Atlan tag options that set the color for the tag, using the default tag icon.
      Parameters:
      color - to use to represent the Atlan tag
      Returns:
      the necessary options for setting this color for the Atlan tag

    • withIcon

      public static AtlanTagOptions withIcon(AtlanIcon icon, AtlanTagColor color)
      Provide Atlan tag options that set the icon and color for the tag, using a built-in icon.
      Parameters:
      icon - to use to represent the Atlan tag
      color - to use to represent the Atlan tag
      Returns:
      the necessary options for setting this icon and color for the Atlan tag

    • withImage

      public static AtlanTagOptions withImage(String url) throws AtlanException
      Provide Atlan tag options that set the image for the tag, using an uploaded image.
      Parameters:
      url - URL to the image to use for the Atlan tag
      Returns:
      the necessary options for setting this image for the Atlan tag
      Throws:
      AtlanException - on any API communication issues trying to upload the image

    • withImage

      public static AtlanTagOptions withImage(AtlanClient client, String url) throws AtlanException
      Provide Atlan tag options that set the image for the tag, using an uploaded image.
      Parameters:
      client - connectivity to the Atlan tenant in which the tag is intended to be created
      url - URL to the image to use for the Atlan tag
      Returns:
      the necessary options for setting this image for the Atlan tag
      Throws:
      AtlanException - on any API communication issues trying to upload the image

    • withEmoji

      public static AtlanTagOptions withEmoji(String emoji)
      Provide Atlan tag options that set the logo for the tag to the provided emoji.
      Parameters:
      emoji - the emoji character to use for the logo
      Returns:
      the necessary options for setting this emoji character as the logo for the Atlan tag

    • builder

      public static AtlanTagOptions.AtlanTagOptionsBuilder<?,?> builder()

    • toBuilder

      public AtlanTagOptions.AtlanTagOptionsBuilder<?,?> toBuilder()

    • getColor

      public String getColor()
      Color to use for the Atlan tag.

    • getIconName

      public AtlanIcon getIconName()
      Name of icon to use to represent the tag visually.

    • getIconType

      public TagIconType getIconType()
      Type of icon to use for representing the tag visually.

    • getEmoji

      public String getEmoji()
      If the iconType is emoji, this should hold the emoji character.

    • getImageID

      public String getImageID()
      Unique identifier (GUID) of an image to use for the tag.

    • equals

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

    • canEqual

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AtlanObject

    • toString

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