Package com.atlan.model.search

Class SearchLogRequest.SearchLogRequestBuilder<C extends SearchLogRequest,B extends SearchLogRequest.SearchLogRequestBuilder<C,B>>

java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.search.SearchLogRequest.SearchLogRequestBuilder<C,B>
Enclosing class:
SearchLogRequest
public abstract static class SearchLogRequest.SearchLogRequestBuilder<C extends SearchLogRequest,B extends SearchLogRequest.SearchLogRequestBuilder<C,B>> extends AtlanObject.AtlanObjectBuilder<C,B>

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchLogRequestBuilder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected B
    $fillValuesFrom(C instance)
     
    B
    aggregation(String key, co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregation)
    Add an aggregation on the search log entries.
    B
    aggregations(Map<String,co.elastic.clients.elasticsearch._types.aggregations.Aggregation> aggregations)
    Add multiple aggregations on the search log entries.
    abstract C
    build()
     
    B
    clearAggregations()
    Remove all aggregations of the search log entries.
    long
    count()
    Return the total number of assets that will match the supplied criteria, using the most minimal query possible (retrieves minimal data).
    B
    dsl(IndexSearchDSL dsl)
    Parameters for the search itself.
    B
    pageSize(int size)
    Set the maximum number of results to retrieve per page of log entries.
    protected abstract B
    self()
     
    B
    sortBy(co.elastic.clients.elasticsearch._types.SortOptions option)
    Add a sort option to sort the resulting search log entries.
    B
    sorts(List<co.elastic.clients.elasticsearch._types.SortOptions> options)
    Add multiple sort options to sort the resulting search log entries.
    Stream<SearchLogEntry>
    stream()
    Run the search to retrieve entries that match the supplied criteria.
    Stream<SearchLogEntry>
    stream(boolean parallel)
    Run the search to retrieve entries that match the supplied criteria.
    String
    toString()
     

    Methods inherited from class com.atlan.model.core.AtlanObject.AtlanObjectBuilder

    rawJsonObject

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SearchLogRequestBuilder

      public SearchLogRequestBuilder()

  • Method Details

    • pageSize

      public B pageSize(int size)
      Set the maximum number of results to retrieve per page of log entries.
      Parameters:
      size - number of results to retrieve per page
      Returns:
      this search log request builder, with the updated size

    • sortBy

      public B sortBy(co.elastic.clients.elasticsearch._types.SortOptions option)
      Add a sort option to sort the resulting search log entries.
      Parameters:
      option - by which to sort the resulting entries
      Returns:
      this search log request builder, with the updated sorting option(s)

    • sorts

      public B sorts(List<co.elastic.clients.elasticsearch._types.SortOptions> options)
      Add multiple sort options to sort the resulting search log entries.
      Parameters:
      options - by which to sort the resulting entries, in order from first sort to final sort
      Returns:
      this search log request builder, with the updated sorting option(s)

    • aggregation

      public B aggregation(String key, co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregation)
      Add an aggregation on the search log entries.
      Parameters:
      key - arbitrary identifier for the aggregation results
      aggregation - the aggregation to add on top of the results
      Returns:
      this search log request builder, with the additional aggregation(s)

    • aggregations

      public B aggregations(Map<String,co.elastic.clients.elasticsearch._types.aggregations.Aggregation> aggregations)
      Add multiple aggregations on the search log entries.
      Parameters:
      aggregations - the aggregations to add on top of the results
      Returns:
      this search log request builder, with the additional aggregation(s)

    • clearAggregations

      public B clearAggregations()
      Remove all aggregations of the search log entries.
      Returns:
      this search log request builder, without any aggregations

    • count

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

    • stream

      public Stream<SearchLogEntry> stream() throws AtlanException
      Run the search to retrieve 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

      public Stream<SearchLogEntry> stream(boolean parallel) throws AtlanException
      Run the search to retrieve 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

    • $fillValuesFrom

      protected B $fillValuesFrom(C instance)
      Overrides:
      $fillValuesFrom in class AtlanObject.AtlanObjectBuilder<C extends SearchLogRequest,B extends SearchLogRequest.SearchLogRequestBuilder<C,B>>

    • dsl

      public B dsl(IndexSearchDSL dsl)
      Parameters for the search itself.
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class AtlanObject.AtlanObjectBuilder<C extends SearchLogRequest,B extends SearchLogRequest.SearchLogRequestBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class AtlanObject.AtlanObjectBuilder<C extends SearchLogRequest,B extends SearchLogRequest.SearchLogRequestBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class AtlanObject.AtlanObjectBuilder<C extends SearchLogRequest,B extends SearchLogRequest.SearchLogRequestBuilder<C,B>>