Package com.atlan.model.search

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 Summary

Constructors

Constructor	Description
AuditSearchBuilder()

Method Summary

Modifier and Type	Method	Description
B	_includeOnResults(String _includeOnResults)
B	_includesOnResults(Collection<? extends String> _includesOnResults)
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	clear_includesOnResults()
B	clearAggregations()
B	clearIncludesOnResults()
B	clearSorts()
long	count()	Return the total number of audit entries that will match the supplied criteria, using the most minimal query possible (retrieves minimal data).
B	includeOnResults(AtlanField includeOnResults)
B	includesOnResults(Collection<? extends AtlanField> includesOnResults)
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<EntityAudit>	stream()	Run the audit search to retrieve audit log entries that match the supplied criteria.
Stream<EntityAudit>	stream(boolean parallel)	Run the audit search to retrieve audit log entries that match the supplied criteria.
AuditSearchRequest	toRequest()	Translate the Atlan audit search into an Atlan audit search request.
AuditSearchRequest.AuditSearchRequestBuilder<?,?>	toRequestBuilder()	Translate the Atlan audit search into an Atlan audit search 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, 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

AuditSearchBuilder

public AuditSearchBuilder()

Method Details

toRequestBuilder

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

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

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

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

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

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.

includeOnResults

public B includeOnResults(AtlanField includeOnResults)

includesOnResults

public B includesOnResults(Collection<? extends AtlanField> includesOnResults)

clearIncludesOnResults

public B clearIncludesOnResults()

_includeOnResults

public B _includeOnResults(String _includeOnResults)

_includesOnResults

public B _includesOnResults(Collection<? extends String> _includesOnResults)

clear_includesOnResults

public B clear_includesOnResults()

self

protected abstract B self()

Specified by:

self in class CompoundQuery.CompoundQueryBuilder<C extends AuditSearch,B extends AuditSearch.AuditSearchBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class CompoundQuery.CompoundQueryBuilder<C extends AuditSearch,B extends AuditSearch.AuditSearchBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class CompoundQuery.CompoundQueryBuilder<C extends AuditSearch,B extends AuditSearch.AuditSearchBuilder<C,B>>