Package com.atlan.model.typedefs

Class CustomMetadataOptions

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.typedefs.CustomMetadataOptions
All Implemented Interfaces:
Serializable
public class CustomMetadataOptions extends AtlanObject
See Also:

  • Constructor Details

  • Method Details

    • withImage

      public static CustomMetadataOptions withImage(String url)
      Provide custom metadata options that set the logo for the custom metadata from the image at the provided URL. The custom metadata will be editable through the UI.
      Parameters:
      url - to an image (for example a .png)
      Returns:
      the necessary options for setting this image as the logo for the custom metadata

    • withImage

      public static CustomMetadataOptions withImage(String url, boolean locked)
      Provide custom metadata options that set the logo for the custom metadata from the image at the provided URL.
      Parameters:
      url - to an image (for example a .png)
      locked - if true, the custom metadata cannot be modified through the Atlan UI
      Returns:
      the necessary options for setting this image as the logo for the custom metadata

    • withEmoji

      public static CustomMetadataOptions withEmoji(String emoji)
      Provide custom metadata options that set the logo for the custom metadata to the provided emoji. The custom metadata will be editable through the UI.
      Parameters:
      emoji - the emoji character to use for the logo
      Returns:
      the necessary options for setting this emoji character as the logo for the custom metadata

    • withEmoji

      public static CustomMetadataOptions withEmoji(String emoji, boolean locked)
      Provide custom metadata options that set the logo for the custom metadata to the provided emoji.
      Parameters:
      emoji - the emoji character to use for the logo
      locked - if true, the custom metadata cannot be modified through the Atlan UI
      Returns:
      the necessary options for setting this emoji character as the logo for the custom metadata

    • withIcon

      public static CustomMetadataOptions withIcon(AtlanIcon icon, AtlanTagColor color)
      Provide custom metadata options that set the logo for the custom metadata to the provided icon and color. The custom metadata will be editable through the UI.
      Parameters:
      icon - the icon to use for the logo
      color - the color to use for the icon
      Returns:
      the necessary options for setting this icon (and color) as the logo for the custom metadata

    • withIcon

      public static CustomMetadataOptions withIcon(AtlanIcon icon, AtlanTagColor color, boolean locked)
      Provide custom metadata options that set the logo for the custom metadata to the provided icon.
      Parameters:
      icon - the icon to use for the logo
      color - the color to use for the icon
      locked - if true, the custom metadata cannot be modified through the Atlan UI
      Returns:
      the necessary options for setting this icon (and color) as the logo for the custom metadata

    • builder

      public static CustomMetadataOptions.CustomMetadataOptionsBuilder<?,?> builder()

    • getLogoType

      public LogoType getLogoType()
      Type of logo used for the custom metadata.

    • getIconColor

      public AtlanTagColor getIconColor()
      Color to use for the icon.

    • getIconName

      public AtlanIcon getIconName()
      Icon to use to represent the custom metadata.

    • getEmoji

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

    • getLogoUrl

      public String getLogoUrl()
      If the logoType is image, this should hold a URL to the image.

    • getIsLocked

      public String getIsLocked()
      Indicates whether the custom metadata can be managed in the UI (false) or not (true).

    • getImageId

      public String getImageId()
      Unique identifier (GUID) of the image used for the logo, for logos that are uploaded directly to Atlan.

    • 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