Package com.atlan.model.typedefs

Class CustomMetadataDef

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.typedefs.TypeDef
com.atlan.model.typedefs.CustomMetadataDef
All Implemented Interfaces:
Serializable
public class CustomMetadataDef extends TypeDef
Structural definition of custom metadata.
See Also:

  • Constructor Details

  • Method Details

    • creator

      public static CustomMetadataDef.CustomMetadataDefBuilder<?,?> creator(String displayName)
      Builds the minimal object necessary to create a custom metadata definition. Note: without any enrichment, this will create a custom metadata set with no attributes. This is valid, but probably not useful for anything!
      Parameters:
      displayName - the human-readable name for the custom metadata set
      Returns:
      the minimal request necessary to create the custom metadata typedef, as a builder

    • create

      public CustomMetadataDef create() throws AtlanException
      Create this custom metadata definition in Atlan.
      Returns:
      the result of the creation, or null if the creation failed
      Throws:
      AtlanException - on any API communication issues

    • create

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

    • update

      public CustomMetadataDef update() throws AtlanException
      Update this custom metadata definition in Atlan. Note: there are many restrictions on what you can / should update, so this should really be treated as an internal method. (This will also force a refresh of the custom metadata cache.)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API communication issues

    • update

      public CustomMetadataDef update(AtlanClient client) throws AtlanException
      Update this custom metadata definition in Atlan. Note: there are many restrictions on what you can / should update, so this should really be treated as an internal method. (This will also force a refresh of the custom metadata cache.)
      Parameters:
      client - connectivity to the Atlan tenant on which to update the custom metadata
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API communication issues

    • purge

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

    • purge

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

    • builder

      public static CustomMetadataDef.CustomMetadataDefBuilder<?,?> builder()

    • toBuilder

      public CustomMetadataDef.CustomMetadataDefBuilder<?,?> toBuilder()

    • getOptions

      public CustomMetadataOptions getOptions()
      Options for the custom metadata.

    • 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 custom metadata typedefs.
      Overrides:
      getCategory in class TypeDef