Package com.atlan.model.search

Class AuditSearch

java.lang.Object
com.atlan.model.search.CompoundQuery
com.atlan.model.search.AuditSearch
public class AuditSearch extends CompoundQuery
Search abstraction mechanism, to simplify the most common searches against Atlan's audit log (removing the need to understand the guts of Elastic).

  • Constructor Details

  • Method Details

    • builder

      public static AuditSearch.AuditSearchBuilder<?,?> builder(AtlanClient client)
      Build an audit search against the provided Atlan tenant.
      Parameters:
      client - connectivity to an Atlan tenant
      Returns:
      the start of an audit search against the tenant

    • toRequest

      public AuditSearchRequest toRequest()
      Translate the Atlan audit search into an Atlan audit search request.
      Returns:
      an Atlan audit search request that encapsulates the audit search

    • count

      public long count() throws AtlanException
      Return the total number of audit entries that will match the supplied criteria, using the most minimal query possible (retrieves minimal data).
      Returns:
      the count of audit entries that will match the supplied criteria
      Throws:
      AtlanException - on any issues interacting with the Atlan APIs

    • stream

      public Stream<EntityAudit> stream() throws AtlanException
      Run the audit search to retrieve audit entries that match the supplied criteria.
      Returns:
      a stream of audit entries that match the specified criteria, lazily-fetched
      Throws:
      AtlanException - on any issues interacting with the Atlan APIs

    • stream

      public Stream<EntityAudit> stream(boolean parallel) throws AtlanException
      Run the audit search to retrieve audit entries that match the supplied criteria.
      Parameters:
      parallel - if true, returns a parallel stream
      Returns:
      a stream of audit entries that match the specified criteria, lazily-fetched
      Throws:
      AtlanException - on any issues interacting with the Atlan APIs

    • parallelStream

      public Stream<EntityAudit> parallelStream() throws AtlanException
      Run the audit search to retrieve audit entries that match the supplied criteria, using a parallel stream (multiple pages are retrieved in parallel for improved throughput).
      Returns:
      a stream of audit entries that match the specified criteria, lazily-fetched
      Throws:
      AtlanException - on any issues interacting with the Atlan APIs

    • bulkStream

      public Stream<EntityAudit> bulkStream() throws AtlanException
      Run the fluent search to retrieve assets that match the supplied criteria, using a stream specifically meant for streaming large numbers of results (10,000 or more). Note: this will apply its own sorting algorithm, so any sort order you have specified may be ignored.
      Returns:
      a stream of assets that match the specified criteria, lazily-fetched
      Throws:
      AtlanException - on any issues interacting with the Atlan APIs

    • _dsl

      protected IndexSearchDSL.IndexSearchDSLBuilder<?,?> _dsl()
      Translate the Atlan audit search into an Atlan search DSL builder.
      Returns:
      an Atlan search DSL builder that encapsulates the audit search

    • _requestBuilder

      protected AuditSearchRequest.AuditSearchRequestBuilder<?,?> _requestBuilder()
      Translate the Atlan audit search into an Atlan audit search request builder.
      Returns:
      an Atlan audit search request builder that encapsulates the audit search

    • _internal

      public static AuditSearch.AuditSearchBuilder<?,?> _internal()