Package com.atlan.model.search

Class AuditSearchRequest

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.search.AuditSearchRequest
All Implemented Interfaces:
Serializable
public class AuditSearchRequest extends AtlanObject
Class from which to configure and run a search against Atlan's activity log.
See Also:

  • Field Details

    • CREATED

      public static final NumericField CREATED
      When the asset was created.

    • ENTITY_ID

      public static final KeywordField ENTITY_ID
      Unique identifier (GUID) of the asset that was created or changed.

    • ENTITY_TYPE

      public static final KeywordField ENTITY_TYPE
      Type of the asset that was created or changed.

    • QUALIFIED_NAME

      public static final KeywordField QUALIFIED_NAME
      Unique name of the asset that was created or changed.

    • USER

      public static final KeywordField USER
      User who made the update to the asset.

    • ACTION

      public static final KeywordField ACTION
      Type of action made against the asset.

    • AGENT

      public static final KeywordField AGENT
      Type of actor (e.g. workflow) that created or changed the asset, if it was done programmatically.

    • PACKAGE_NAME

      public static final KeywordField PACKAGE_NAME
      Name of the package that created or changed the asset.

    • WORKFLOW_ID

      public static final KeywordField WORKFLOW_ID
      Name of the workflow (specific configuration of a package) that created or changed the asset.

    • AGENT_ID

      public static final KeywordField AGENT_ID
      Name of the agent (specific run of a workflow) that created or changed the asset.

  • Constructor Details

  • Method Details

    • search

      public AuditSearchResponse search() throws AtlanException
      Run the search.
      Returns:
      the matching audit log records
      Throws:
      AtlanException

    • search

      public AuditSearchResponse search(AtlanClient client) throws AtlanException
      Run the search.
      Parameters:
      client - connectivity to the Atlan tenant on which to search the audit logs
      Returns:
      the matching audit log records
      Throws:
      AtlanException

    • byGuid

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> byGuid(String guid, int size)
      Start building an audit search request for the last changes to an asset, by its GUID.
      Parameters:
      guid - unique identifier of the asset for which to retrieve the audit history
      size - number of changes to retrieve
      Returns:
      a request builder pre-configured with these criteria

    • byGuid

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> byGuid(AtlanClient client, String guid, int size)
      Start building an audit search request for the last changes to an asset, by its GUID.
      Parameters:
      client - connectivity to the Atlan tenant on which to search the audit logs
      guid - unique identifier of the asset for which to retrieve the audit history
      size - number of changes to retrieve
      Returns:
      a request builder pre-configured with these criteria

    • byQualifiedName

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> byQualifiedName(String typeName, String qualifiedName, int size)
      Start building an audit search request for the last changes to an asset, by its qualifiedName.
      Parameters:
      typeName - the type of asset for which to retrieve the audit history
      qualifiedName - unique name of the asset for which to retrieve the audit history
      size - number of changes to retrieve
      Returns:
      a request builder pre-configured with these criteria

    • byQualifiedName

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> byQualifiedName(AtlanClient client, String typeName, String qualifiedName, int size)
      Start building an audit search request for the last changes to an asset, by its qualifiedName.
      Parameters:
      client - connectivity to the Atlan tenant on which to search the audit logs
      typeName - the type of asset for which to retrieve the audit history
      qualifiedName - unique name of the asset for which to retrieve the audit history
      size - number of changes to retrieve
      Returns:
      a request builder pre-configured with these criteria

    • byUser

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> byUser(String userName, int size)
      Start building an audit search request for the last changes made to any assets, by a given user.
      Parameters:
      userName - the name of the user for which to look for any changes
      size - number of changes to retrieve
      Returns:
      a request builder pre-configured with these criteria

    • byUser

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> byUser(AtlanClient client, String userName, int size)
      Start building an audit search request for the last changes made to any assets, by a given user.
      Parameters:
      client - connectivity to the Atlan tenant on which to search the audit logs
      userName - the name of the user for which to look for any changes
      size - number of changes to retrieve
      Returns:
      a request builder pre-configured with these criteria

    • byAction

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> byAction(String action, int size)
      Start building an audit search request for the last common action made to any assets.
      Parameters:
      action - type of action (e.g. ENTITY_CREATE)
      size - number of changes to retrieve
      Returns:
      a request builder pre-configured with these criteria

    • byAction

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> byAction(AtlanClient client, String action, int size)
      Start building an audit search request for the last common action made to any assets.
      Parameters:
      client - connectivity to the Atlan tenant on which to search the audit logs
      action - type of action (e.g. ENTITY_CREATE)
      size - number of changes to retrieve
      Returns:
      a request builder pre-configured with these criteria

    • builder

      public static AuditSearchRequest.AuditSearchRequestBuilder<?,?> builder()

    • toBuilder

      public AuditSearchRequest.AuditSearchRequestBuilder<?,?> toBuilder()

    • getDsl

      public IndexSearchDSL getDsl()
      Parameters for the search itself.

    • getAttributes

      public List<String> getAttributes()
      Attributes to include in the entityDetail of each resulting audit entry.

    • 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