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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AtlanTagDef.AtlanTagDefBuilder<C extends AtlanTagDef,B extends AtlanTagDef.AtlanTagDefBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.typedefs.TypeDef

TypeDef.TypeDefBuilder<C extends TypeDef,B extends TypeDef.TypeDefBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AtlanTagDef(AtlanTagDef.AtlanTagDefBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static AtlanTagDef.AtlanTagDefBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
AtlanTagDef	create(AtlanClient client)	Create this Atlan tag definition in Atlan.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	creator(AtlanClient client, String displayName, String url)	Builds the minimal object necessary to create an Atlan tag definition.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	creator(AtlanClient client, String displayName, String url, boolean sourceSynced)	Builds the minimal object necessary to create an Atlan tag definition.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	creator(String displayName, boolean sourceSynced)	Builds the minimal object necessary to create an Atlan tag definition.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	creator(String displayName, AtlanIcon icon, AtlanTagColor color)	Builds the minimal object necessary to create an Atlan tag definition.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	creator(String displayName, AtlanIcon icon, AtlanTagColor color, boolean sourceSynced)	Builds the minimal object necessary to create an Atlan tag definition.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	creator(String displayName, AtlanTagColor color)	Builds the minimal object necessary to create an Atlan tag definition, using the default tag icon.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	creator(String displayName, AtlanTagColor color, boolean sourceSynced)	Builds the minimal object necessary to create an Atlan tag definition, using the default tag icon.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	creator(String displayName, AtlanTagOptions options)	Builds the minimal object necessary to create an Atlan tag definition.
boolean	equals(Object o)
AtlanTypeCategory	getCategory()	Fixed category for Atlan tag typedefs.
List<String>	getEntityTypes()	List of the types of entities that the Atlan tag can be applied to.
AtlanTagOptions	getOptions()	Options that describe the Atlan tag.
Boolean	getSkipDisplayNameUniquenessCheck()	TBC
List<String>	getSubTypes()	Unused.
List<String>	getSuperTypes()	Unused.
int	hashCode()
static void	purge(AtlanClient client, String displayName)	Hard-deletes (purges) an Atlan tag by its human-readable name.
static AtlanTagDef.AtlanTagDefBuilder<?,?>	setupSourceSynced(AtlanTagDef.AtlanTagDefBuilder<?,?> builder, boolean sourceSynced)	Configure the builder for the tag to support source-synced attributes.
AtlanTagDef.AtlanTagDefBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.typedefs.TypeDef

getAttributeDefs, getCreatedBy, getCreateTime, getDescription, getDisplayName, getGuid, getName, getServiceType, getTypeVersion, getUpdatedBy, getUpdateTime, getVersion

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AtlanTagDef

protected AtlanTagDef(AtlanTagDef.AtlanTagDefBuilder<?,?> b)

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,
 AtlanTagColor color,
 boolean sourceSynced)

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

sourceSynced - if true, configure this tag as a source-synced 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,
 AtlanIcon icon,
 AtlanTagColor color,
 boolean sourceSynced)

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

sourceSynced - if true, configure this tag as a source-synced tag

Returns:

the minimal request necessary to create the Atlan tag typedef, as a builder

creator

public static AtlanTagDef.AtlanTagDefBuilder<?,?> creator(AtlanClient client,
 String displayName,
 String url)
                                                   throws AtlanException

Builds the minimal object necessary to create an Atlan tag definition.

Parameters:

client - connectivity to the Atlan tenant in which the tag is intended to be created

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(AtlanClient client,
 String displayName,
 String url,
 boolean sourceSynced)
                                                   throws AtlanException

Builds the minimal object necessary to create an Atlan tag definition.

Parameters:

client - connectivity to the Atlan tenant in which the tag is intended to be created

displayName - the human-readable name for the Atlan tag

url - URL to an image to use for the Atlan tag

sourceSynced - if true, configure this tag as a source-synced 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

creator

public static AtlanTagDef.AtlanTagDefBuilder<?,?> creator(String displayName,
 boolean sourceSynced)
                                                   throws AtlanException

Builds the minimal object necessary to create an Atlan tag definition.

Parameters:

displayName - the human-readable name for the Atlan tag

sourceSynced - if true, configure this tag as a source-synced 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

setupSourceSynced

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

Configure the builder for the tag to support source-synced attributes.

Parameters:

builder - for the tag definition

sourceSynced - if true, add the necessary structure for source-synced tags, otherwise do nothing

Returns:

the tag builder, modified to handle source-synced tags

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(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