Package com.atlan.model.admin

Class AtlanTagRequest

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.admin.AtlanRequest

com.atlan.model.admin.AtlanTagRequest

All Implemented Interfaces:

Serializable

public class AtlanTagRequest
extends AtlanRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AtlanTagRequest.AtlanTagRequestBuilder<C extends AtlanTagRequest,B extends AtlanTagRequest.AtlanTagRequestBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.admin.AtlanRequest

AtlanRequest.AtlanRequestBuilder<C extends AtlanRequest,B extends AtlanRequest.AtlanRequestBuilder<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

Modifier and Type	Field	Description
static final String	REQUEST_TYPE
static final String	SOURCE_TYPE

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

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AtlanTagRequest(AtlanTagRequest.AtlanTagRequestBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static AtlanTagRequest.AtlanTagRequestBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
static AtlanTagRequest.AtlanTagRequestBuilder<?,?>	creator(Asset asset, AtlanTagPayload atlanTagDetails)	Create a new request to attach an Atlan tag to an asset.
static AtlanTagRequest.AtlanTagRequestBuilder<?,?>	creator(String assetGuid, String assetQualifiedName, String assetType, AtlanTagPayload atlanTagDetails)	Create a new request to attach an Atlan tag to an asset.
boolean	equals(Object o)
AtlanTagPayload	getPayload()	Details of the requested Atlan tag.
String	getRequestType()	Fixed requestType for Atlan tags.
String	getSourceType()	Fixed sourceType for Atlan tags.
int	hashCode()
AtlanTagRequest.AtlanTagRequestBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.admin.AtlanRequest

approve, create, getAccessEndDate, getAccessStartDate, getApprovalType, getApprovedBy, getAssignedApprovers, getBotRunId, getConfidenceScore, getCreatedAt, getCreatedBy, getDestinationAttribute, getDestinationEntity, getDestinationGuid, getDestinationQualifiedName, getDestinationValue, getDestinationValueAction, getDestinationValueArray, getDestinationValueObject, getDestinationValueType, getEntityType, getHash, getId, getIsActive, getIsDuplicate, getMessage, getRejectedBy, getRequestApproverGroups, getRequestApproverRoles, getRequestApproverUsers, getRequestDenyGroups, getRequestDenyRoles, getRequestDenyUsers, getRequestsBatch, getSourceAttribute, getSourceEntity, getSourceGuid, getSourceQualifiedName, getStatus, getTenantId, getUpdatedAt, getVersion, list, reject, retrieveByGuid

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

Field Details

REQUEST_TYPE

public static final String REQUEST_TYPE

See Also:

• Constant Field Values

SOURCE_TYPE

public static final String SOURCE_TYPE

See Also:

• Constant Field Values

Constructor Details

AtlanTagRequest

protected AtlanTagRequest(AtlanTagRequest.AtlanTagRequestBuilder<?,?> b)

Method Details

creator

public static AtlanTagRequest.AtlanTagRequestBuilder<?,?> creator(Asset asset,
 AtlanTagPayload atlanTagDetails)
                                                           throws InvalidRequestException

Create a new request to attach an Atlan tag to an asset. Note that the asset must have at least its real (not placeholder) GUID and qualifiedName populated.

Parameters:

asset - against which to raise the request

atlanTagDetails - details of the requested Atlan tag

Returns:

a builder for the request with these details

Throws:

InvalidRequestException - if any of the required details for the provided asset are missing

creator

public static AtlanTagRequest.AtlanTagRequestBuilder<?,?> creator(String assetGuid,
 String assetQualifiedName,
 String assetType,
 AtlanTagPayload atlanTagDetails)

Create a new request to attach an Atlan tag to an asset.

Parameters:

assetGuid - unique identifier (GUID) of the asset to classify

assetQualifiedName - qualifiedName of the asset to classify

assetType - type of the asset to classify

atlanTagDetails - details of the requested Atlan tag

Returns:

a builder for the request with these details

builder

public static AtlanTagRequest.AtlanTagRequestBuilder<?,?> builder()

toBuilder

public AtlanTagRequest.AtlanTagRequestBuilder<?,?> toBuilder()

getPayload

public AtlanTagPayload getPayload()

Details of the requested Atlan tag.

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanRequest

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanRequest

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanRequest

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanRequest

getRequestType

public String getRequestType()

Fixed requestType for Atlan tags.

Overrides:

getRequestType in class AtlanRequest

getSourceType

public String getSourceType()

Fixed sourceType for Atlan tags.

Overrides:

getSourceType in class AtlanRequest