Package com.atlan.model.admin

Class AtlanTagPayload

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.admin.AtlanRequestPayload

com.atlan.model.admin.AtlanTagPayload

All Implemented Interfaces:

Serializable

public class AtlanTagPayload
extends AtlanRequestPayload

Captures the details of an Atlan tag in a request.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AtlanTagPayload.AtlanTagPayloadBuilder

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

Method Summary

Modifier and Type	Method	Description
static AtlanTagPayload.AtlanTagPayloadBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Boolean	getPropagate()	Whether the Atlan tag should propagate.
Boolean	getRemovePropagationsOnEntityDelete()	Whether removing the Atlan tag should also remove its propagations.
String	getTypeName()	Name of the Atlan tag.
List<Object>	getValidityPeriods()	Unused.
int	hashCode()
static AtlanTagPayload	of(String atlanTagName)	Create a Atlan tag payload with the specified Atlan tag and defaults for propagation.
static AtlanTagPayload	of(String atlanTagName, boolean propagate, boolean removePropagationsOnDelete)	Create an Atlan tag payload with the specified details.
AtlanTagPayload.AtlanTagPayloadBuilder	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

Method Details

of

public static AtlanTagPayload of(String atlanTagName)

Create a Atlan tag payload with the specified Atlan tag and defaults for propagation.

Parameters:

atlanTagName - human-readable name of the Atlan tag

Returns:

the Atlan tag payload with defaults for propagation

of

public static AtlanTagPayload of(String atlanTagName,
 boolean propagate,
 boolean removePropagationsOnDelete)

Create an Atlan tag payload with the specified details.

Parameters:

atlanTagName - human-readable name of the Atlan tag

propagate - whether the Atlan tag should propagate (true) or not (false)

removePropagationsOnDelete - whether the propagated Atlan tags should be cascaded (true) or not (false)

Returns:

the Atlan tag payload with the specified propagation settings

builder

public static AtlanTagPayload.AtlanTagPayloadBuilder builder()

toBuilder

public AtlanTagPayload.AtlanTagPayloadBuilder toBuilder()

getTypeName

public String getTypeName()

Name of the Atlan tag.

getPropagate

public Boolean getPropagate()

Whether the Atlan tag should propagate.

getRemovePropagationsOnEntityDelete

public Boolean getRemovePropagationsOnEntityDelete()

Whether removing the Atlan tag should also remove its propagations.

getValidityPeriods

public List<Object> getValidityPeriods()

Unused.

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 AtlanRequestPayload