Package com.atlan.model.admin

Class AtlanRequest

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.admin.AtlanRequest
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AtlanTagRequest, AttributeRequest, CustomMetadataRequest, TermLinkRequest
public abstract class AtlanRequest extends AtlanObject
See Also:

  • Constructor Details

  • Method Details

    • create

      public void create() throws AtlanException
      Create the request in Atlan that is represented by this object.
      Throws:
      AtlanException - on any API interaction issues

    • create

      public void create(AtlanClient client) throws AtlanException
      Create the request in Atlan that is represented by this object.
      Parameters:
      client - connectivity to the Atlan tenant in which to create the request
      Throws:
      AtlanException - on any API interaction issues

    • list

      public static AtlanRequestResponse list() throws AtlanException
      Retrieve the list of requests defined in Atlan as you would via the Admin UI.
      Returns:
      a list of all the requests in Atlan
      Throws:
      AtlanException - on any API communication issue

    • list

      public static AtlanRequestResponse list(AtlanClient client) throws AtlanException
      Retrieve the list of requests defined in Atlan as you would via the Admin UI.
      Parameters:
      client - connectivity to the Atlan tenant from which to list requests
      Returns:
      a list of all the requests in Atlan
      Throws:
      AtlanException - on any API communication issue

    • retrieveByGuid

      public static AtlanRequest retrieveByGuid(String guid) throws AtlanException
      Fetch a single request by its unique identifier (GUID).
      Parameters:
      guid - unique identifier (GUID) of the request to fetch.
      Returns:
      the single request, or null if none was found
      Throws:
      AtlanException - on any API communication issue

    • retrieveByGuid

      public static AtlanRequest retrieveByGuid(AtlanClient client, String guid) throws AtlanException
      Fetch a single request by its unique identifier (GUID).
      Parameters:
      client - connectivity to the Atlan tenant from which to fetch the request
      guid - unique identifier (GUID) of the request to fetch.
      Returns:
      the single request, or null if none was found
      Throws:
      AtlanException - on any API communication issue

    • approve

      public static boolean approve(String guid, String message) throws AtlanException
      Approve the specified request in Atlan.
      Parameters:
      guid - unique identifier (GUID) of the request to approve
      message - (optional) message to include with the approval
      Returns:
      true if the approval succeeded, otherwise false
      Throws:
      AtlanException - on any API interaction issues

    • approve

      public static boolean approve(AtlanClient client, String guid, String message) throws AtlanException
      Approve the specified request in Atlan.
      Parameters:
      client - connectivity to the Atlan tenant in which to approve the request
      guid - unique identifier (GUID) of the request to approve
      message - (optional) message to include with the approval
      Returns:
      true if the approval succeeded, otherwise false
      Throws:
      AtlanException - on any API interaction issues

    • reject

      public static boolean reject(String guid, String message) throws AtlanException
      Reject the specified request in Atlan.
      Parameters:
      guid - unique identifier (GUID) of the request to reject
      message - (optional) message to include with the rejection
      Returns:
      true if the rejection succeeded, otherwise false
      Throws:
      AtlanException - on any API interaction issues

    • reject

      public static boolean reject(AtlanClient client, String guid, String message) throws AtlanException
      Reject the specified request in Atlan.
      Parameters:
      client - connectivity to the Atlan tenant in which to reject the request
      guid - unique identifier (GUID) of the request to reject
      message - (optional) message to include with the rejection
      Returns:
      true if the rejection succeeded, otherwise false
      Throws:
      AtlanException - on any API interaction issues

    • getId

      public String getId()
      Unique identifier for the request (GUID).

    • getVersion

      public String getVersion()
      Unique version name for the request.

    • getIsActive

      public Boolean getIsActive()
      If true, the request is still open.

    • getCreatedAt

      public Long getCreatedAt()
      Date and time at which the request was created.

    • getUpdatedAt

      public Long getUpdatedAt()
      Date and time at which the request was last updated.

    • getCreatedBy

      public String getCreatedBy()
      User who created the request.

    • getTenantId

      public String getTenantId()
      Name of the tenant for the request (usually `default`).

    • getSourceType

      public String getSourceType()
      Should be `static` for an ATTRIBUTE or CUSTOM_METADATA requestType, and `atlas` for other request types.

    • getSourceGuid

      public String getSourceGuid()
      Unique identifier (GUID) of the asset being related through this request, for example the term's GUID for a TERM_LINK.

    • getSourceQualifiedName

      public String getSourceQualifiedName()
      Unique name of the asset being related through this request, for example the term's qualifiedName for a TERM_LINK.

    • getSourceAttribute

      public String getSourceAttribute()
      TBC

    • getDestinationGuid

      public String getDestinationGuid()
      Unique identifier (GUID) of the asset this request was made against.

    • getDestinationQualifiedName

      public String getDestinationQualifiedName()
      Unique name of the asset this request was made against.

    • getDestinationAttribute

      public String getDestinationAttribute()
      Attribute the request was made against.

    • getDestinationValue

      public String getDestinationValue()
      Requested value for the attribute.

    • getDestinationValueType

      public String getDestinationValueType()
      Type of the destination attribute value, for example `array`.

    • getDestinationValueArray

      public Object getDestinationValueArray()
      Unused.

    • getDestinationValueObject

      public Object getDestinationValueObject()
      Unused.

    • getEntityType

      public String getEntityType()
      Type of asset the change was requested against.

    • getRequestType

      public String getRequestType()
      Type of change the request is for.

    • getConfidenceScore

      public Object getConfidenceScore()
      Unused.

    • getBotRunId

      public Object getBotRunId()
      Unused.

    • getApprovedBy

      public String getApprovedBy()
      User who approved the request.

    • getRejectedBy

      public String getRejectedBy()
      User who rejected the request.

    • getStatus

      public AtlanRequestStatus getStatus()
      Status of the request.

    • getMessage

      public String getMessage()
      Comment recorded with the approval or rejection of the request.

    • getRequestsBatch

      public Object getRequestsBatch()
      Unused.

    • getApprovalType

      public String getApprovalType()
      Type of approval required — currently only `single` is supported.

    • getAssignedApprovers

      public Object getAssignedApprovers()
      Unused.

    • getAccessStartDate

      public Object getAccessStartDate()
      Unused.

    • getAccessEndDate

      public Object getAccessEndDate()
      Unused.

    • getHash

      public Long getHash()
      TBC

    • getIsDuplicate

      public Boolean getIsDuplicate()
      TBC

    • getDestinationValueAction

      public String getDestinationValueAction()
      Semantic to use when applying the destination value, for example `append`.

    • getRequestApproverUsers

      public SortedSet<String> getRequestApproverUsers()
      Names of users (in Keycloak) that can approve this request.

    • getRequestApproverGroups

      public SortedSet<String> getRequestApproverGroups()
      TBC

    • getRequestApproverRoles

      public SortedSet<String> getRequestApproverRoles()
      Names of roles (in Keycloak) that can approve this request.

    • getRequestDenyUsers

      public SortedSet<String> getRequestDenyUsers()
      Names of users (in Keycloak) that can deny this request.

    • getRequestDenyGroups

      public SortedSet<String> getRequestDenyGroups()
      TBC

    • getRequestDenyRoles

      public SortedSet<String> getRequestDenyRoles()
      Unique identifiers (GUIDs) of the roles that can deny this request.

    • getSourceEntity

      public Object getSourceEntity()
      TBC

    • getDestinationEntity

      public Asset getDestinationEntity()
      Limited details about the asset this request was made against.

    • 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