Class AuditSearch.AuditSearchBuilder<C extends AuditSearch,B extends AuditSearch.AuditSearchBuilder<C,B>>

java.lang.Object
com.atlan.model.search.CompoundQuery.CompoundQueryBuilder<C,B>
com.atlan.model.search.AuditSearch.AuditSearchBuilder<C,B>
Enclosing class:
AuditSearch

public abstract static class AuditSearch.AuditSearchBuilder<C extends AuditSearch,B extends AuditSearch.AuditSearchBuilder<C,B>> extends CompoundQuery.CompoundQueryBuilder<C,B>
  • Constructor Details Link icon

    • AuditSearchBuilder Link icon

      public AuditSearchBuilder()
  • Method Details Link icon

    • toRequestBuilder Link icon

      public AuditSearchRequest.AuditSearchRequestBuilder<?,?> toRequestBuilder()
      Translate the Atlan audit search into an Atlan audit search request builder.
      Returns:
      an Atlan audit search request builder that encapsulates the audit search
    • toRequest Link icon

      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 Link icon

      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 Link icon

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

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

      public B sort(co.elastic.clients.elasticsearch._types.SortOptions sort)
    • sorts Link icon

      public B sorts(Collection<? extends co.elastic.clients.elasticsearch._types.SortOptions> sorts)
    • clearSorts Link icon

      public B clearSorts()
    • aggregate Link icon

      public B aggregate(String aggregateKey, co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregateValue)
    • aggregations Link icon

      public B aggregations(Map<? extends String,? extends co.elastic.clients.elasticsearch._types.aggregations.Aggregation> aggregations)
    • clearAggregations Link icon

      public B clearAggregations()
    • pageSize Link icon

      public B pageSize(Integer pageSize)
      Number of results to retrieve per underlying API request.
      Returns:
      this.
    • includeOnResults Link icon

      public B includeOnResults(AtlanField includeOnResults)
    • includesOnResults Link icon

      public B includesOnResults(Collection<? extends AtlanField> includesOnResults)
    • clearIncludesOnResults Link icon

      public B clearIncludesOnResults()
    • _includeOnResults Link icon

      public B _includeOnResults(String _includeOnResults)
    • _includesOnResults Link icon

      public B _includesOnResults(Collection<? extends String> _includesOnResults)
    • clear_includesOnResults Link icon

      public B clear_includesOnResults()
    • self Link icon

      protected abstract B self()
      Specified by:
      self in class CompoundQuery.CompoundQueryBuilder<C extends AuditSearch,B extends AuditSearch.AuditSearchBuilder<C,B>>
    • build Link icon

      public abstract C build()
      Specified by:
      build in class CompoundQuery.CompoundQueryBuilder<C extends AuditSearch,B extends AuditSearch.AuditSearchBuilder<C,B>>
    • toString Link icon

      public String toString()
      Overrides:
      toString in class CompoundQuery.CompoundQueryBuilder<C extends AuditSearch,B extends AuditSearch.AuditSearchBuilder<C,B>>