Class SearchLog.SearchLogBuilder<C extends SearchLog,B extends SearchLog.SearchLogBuilder<C,B>>

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

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

    • SearchLogBuilder Link icon

      public SearchLogBuilder()
  • Method Details Link icon

    • toRequestBuilder Link icon

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

      public SearchLogRequest toRequest()
      Translate the Atlan search log search into an Atlan search log request.
      Returns:
      an Atlan search log request that encapsulates the search
    • count Link icon

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

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

      public Stream<SearchLogEntry> stream(boolean parallel) throws AtlanException
      Run the search log search to retrieve search log entries that match the supplied criteria.
      Parameters:
      parallel - if true, returns a parallel stream
      Returns:
      a stream of search 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.
    • self Link icon

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

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

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