Package com.atlan.model.core

Class AtlanTag

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.core.AtlanTag

All Implemented Interfaces:

AuditDetail, Serializable, Comparable<AtlanTag>

public class AtlanTag
extends AtlanObject
implements AuditDetail, Comparable<AtlanTag>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AtlanTag.AtlanTagBuilder<C extends AtlanTag,B extends AtlanTag.AtlanTagBuilder<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
	AtlanTag()
protected	AtlanTag(AtlanTag.AtlanTagBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static AtlanTag.AtlanTagBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
int	compareTo(AtlanTag o)
boolean	equals(Object o)
String	getEntityGuid()	Unique identifier of the entity to which this Atlan tag is attached.
AtlanStatus	getEntityStatus()	Status of the entity.
Boolean	getPropagate()	Whether to propagate this Atlan tag to other entities related to the entity to which the Atlan tag is attached.
Boolean	getRemovePropagationsOnEntityDelete()	Whether to remove this Atlan tag from other entities to which it has been propagated when the Atlan tag is removed from this entity.
Boolean	getRestrictPropagationThroughHierarchy()	Whether to prevent this Atlan tag from propagating through hierarchy (true) or allow it to propagate through hierarchy (false).
Boolean	getRestrictPropagationThroughLineage()	Whether to prevent this Atlan tag from propagating through lineage (true) or allow it to propagate through lineage (false).
List<SourceTagAttachment>	getSourceTagAttachments()	List of attachments of this tag to source-specific tags.
String	getTypeName()	Name of the Atlan tag.
int	hashCode()
static AtlanTag	of(String atlanTagName)	Construct an Atlan tag assignment for an entity that is being created or updated.
static AtlanTag	of(String atlanTagName, SourceTagAttachment sta)	Construct an Atlan tag assignment for an entity that is being created or updated.
static AtlanTag	of(String atlanTagName, String entityGuid)	Construct an Atlan tag assignment for a specific entity.
static AtlanTag	of(String atlanTagName, String entityGuid, SourceTagAttachment sta)	Construct an Atlan tag assignment for a specific entity.
AtlanTag.AtlanTagBuilder<?,?>	toBuilder()
String	toString()

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

Methods inherited from interface com.atlan.model.search.AuditDetail

getRawJsonObject, setRawJsonObject

Constructor Details

AtlanTag

public AtlanTag()

AtlanTag

protected AtlanTag(AtlanTag.AtlanTagBuilder<?,?> b)

Method Details

of

public static AtlanTag of(String atlanTagName)

Construct an Atlan tag assignment for an entity that is being created or updated.

Parameters:

atlanTagName - human-readable name of the Atlan tag

Returns:

an Atlan tag assignment with default settings for propagation

of

public static AtlanTag of(String atlanTagName,
 SourceTagAttachment sta)

Construct an Atlan tag assignment for an entity that is being created or updated.

Parameters:

atlanTagName - human-readable name of the Atlan tag

sta - (optional) source-specific details for the tag

Returns:

an Atlan tag assignment with default settings for propagation

of

public static AtlanTag of(String atlanTagName,
 String entityGuid)

Construct an Atlan tag assignment for a specific entity.

Parameters:

atlanTagName - human-readable name of the Atlan tag

entityGuid - unique identifier (GUID) of the entity to which the Atlan tag is to be assigned

Returns:

an Atlan tag assignment with default settings for propagation and a specific entity assignment

of

public static AtlanTag of(String atlanTagName,
 String entityGuid,
 SourceTagAttachment sta)

Construct an Atlan tag assignment for a specific entity.

Parameters:

atlanTagName - human-readable name of the Atlan tag

entityGuid - unique identifier (GUID) of the entity to which the Atlan tag is to be assigned

sta - (optional) source-specific details for the tag

Returns:

an Atlan tag assignment with default settings for propagation and a specific entity assignment

compareTo

public int compareTo(AtlanTag o)

Specified by:

compareTo in interface Comparable<AtlanTag>

builder

public static AtlanTag.AtlanTagBuilder<?,?> builder()

toBuilder

public AtlanTag.AtlanTagBuilder<?,?> toBuilder()

getTypeName

public String getTypeName()

Name of the Atlan tag. Note that this is the static-hashed unique name of the Atlan tag, not the human-readable displayName.

Specified by:

getTypeName in interface AuditDetail

getEntityGuid

public String getEntityGuid()

Unique identifier of the entity to which this Atlan tag is attached.

getEntityStatus

public AtlanStatus getEntityStatus()

Status of the entity.

getPropagate

public Boolean getPropagate()

Whether to propagate this Atlan tag to other entities related to the entity to which the Atlan tag is attached.

getRemovePropagationsOnEntityDelete

public Boolean getRemovePropagationsOnEntityDelete()

Whether to remove this Atlan tag from other entities to which it has been propagated when the Atlan tag is removed from this entity.

getRestrictPropagationThroughLineage

public Boolean getRestrictPropagationThroughLineage()

Whether to prevent this Atlan tag from propagating through lineage (true) or allow it to propagate through lineage (false).

getRestrictPropagationThroughHierarchy

public Boolean getRestrictPropagationThroughHierarchy()

Whether to prevent this Atlan tag from propagating through hierarchy (true) or allow it to propagate through hierarchy (false).

getSourceTagAttachments

public List<SourceTagAttachment> getSourceTagAttachments()

List of attachments of this tag to source-specific tags.

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