Package com.atlan.model.search

Class SearchLogResponse

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.net.ApiResource
com.atlan.model.search.SearchLogResponse
All Implemented Interfaces:
AtlanResponseInterface, Serializable, Iterable<SearchLogEntry>
public class SearchLogResponse extends ApiResource implements Iterable<SearchLogEntry>
Captures the response from a search against Atlan's search log. Also provides the ability to iteratively page through results, without needing to track or re-run the original query using getNextPage().
See Also:

  • Constructor Details

    • SearchLogResponse

      public SearchLogResponse()

  • Method Details

    • getNextPage

      public SearchLogResponse getNextPage() throws AtlanException
      Retrieve the next page of results from this response.
      Returns:
      next page of results from this response
      Throws:
      AtlanException - on any API interaction problem

    • getSpecificPage

      public List<SearchLogEntry> getSpecificPage(int offset, int pageSize) throws AtlanException
      Retrieve a specific page of results using the same query used to produce this response.
      Parameters:
      offset - starting point for the specific page
      pageSize - maximum number of results beyond the starting point to retrieve
      Returns:
      specific page of results from this response
      Throws:
      AtlanException - on any API interaction problem

    • iterator

      public Iterator<SearchLogEntry> iterator()
      Specified by:
      iterator in interface Iterable<SearchLogEntry>

    • spliterator

      public Spliterator<SearchLogEntry> spliterator()
      Specified by:
      spliterator in interface Iterable<SearchLogEntry>

    • stream

      public Stream<SearchLogEntry> stream()
      Stream the results (lazily) for processing without needing to manually manage paging.
      Returns:
      a lazily-loaded stream of results from the search

    • parallelStream

      public Stream<SearchLogEntry> parallelStream()
      Stream the results in parallel across all pages (may do more than limited to in a request).
      Returns:
      a lazily-loaded stream of results from the search

    • getClient

      public AtlanClient getClient()
      Connectivity to the Atlan tenant where the search was run.

    • getSearchParameters

      public SearchLogRequest getSearchParameters()
      Parameters for the search.

    • getLogEntries

      public List<SearchLogEntry> getLogEntries()
      List of results from the search.

    • getApproximateCount

      public Long getApproximateCount()
      Approximate number of total results.

    • getAggregations

      public Map<String,AggregationResult> getAggregations()
      Map of results for the requested aggregations.

    • 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 ApiResource

    • setClient

      public void setClient(AtlanClient client)
      Connectivity to the Atlan tenant where the search was run.