Package com.atlan.model.search

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 Summary

Constructors

Constructor	Description
SearchLogBuilder()

Method Summary

Modifier and Type	Method	Description
B	aggregate(String aggregateKey, co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregateValue)
B	aggregations(Map<? extends String,? extends co.elastic.clients.elasticsearch._types.aggregations.Aggregation> aggregations)
abstract C	build()
B	clearAggregations()
B	clearSorts()
long	count()	Return the total number of search log entries that will match the supplied criteria, using the most minimal query possible (retrieves minimal data).
B	pageSize(Integer pageSize)	Number of results to retrieve per underlying API request.
protected abstract B	self()
B	sort(co.elastic.clients.elasticsearch._types.SortOptions sort)
B	sorts(Collection<? extends co.elastic.clients.elasticsearch._types.SortOptions> sorts)
Stream<SearchLogEntry>	stream()	Run the search log search to retrieve search log entries that match the supplied criteria.
Stream<SearchLogEntry>	stream(boolean parallel)	Run the search log search to retrieve search log entries that match the supplied criteria.
SearchLogRequest	toRequest()	Translate the Atlan search log search into an Atlan search log request.
SearchLogRequest.SearchLogRequestBuilder<?,?>	toRequestBuilder()	Translate the Atlan search log search into an Atlan search log request builder.
String	toString()

Methods inherited from class com.atlan.model.search.CompoundQuery.CompoundQueryBuilder

active, archived, clearWhereNots, clearWheres, clearWhereSomes, client, minSomes, tagged, tagged, taggedWithValue, taggedWithValue, taggedWithValue, where, whereNot, whereNots, wheres, whereSome, whereSomes, withLineage, withoutLineage

Methods inherited from class java.lang.Object

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

Constructor Details

SearchLogBuilder

public SearchLogBuilder()

Method Details

toRequestBuilder

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

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

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

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

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

public B sort(co.elastic.clients.elasticsearch._types.SortOptions sort)

sorts

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

clearSorts

public B clearSorts()

aggregate

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

aggregations

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

clearAggregations

public B clearAggregations()

pageSize

public B pageSize(Integer pageSize)

Number of results to retrieve per underlying API request.

Returns:

this.

self

protected abstract B self()

Specified by:

self in class CompoundQuery.CompoundQueryBuilder<C extends SearchLog,B extends SearchLog.SearchLogBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class CompoundQuery.CompoundQueryBuilder<C extends SearchLog,B extends SearchLog.SearchLogBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class CompoundQuery.CompoundQueryBuilder<C extends SearchLog,B extends SearchLog.SearchLogBuilder<C,B>>