Package com.atlan.model.search

Class AggregationBucketResult.AggregationBucketResultBuilder

java.lang.Object

com.atlan.model.search.AggregationBucketResult.AggregationBucketResultBuilder

Enclosing class:

AggregationBucketResult

public static class AggregationBucketResult.AggregationBucketResultBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
AggregationBucketResult.AggregationBucketResultBuilder	buckets(List<AggregationBucketDetails> buckets)	List of the top buckets that resulted from the aggregation.
AggregationBucketResult	build()
AggregationBucketResult.AggregationBucketResultBuilder	docCountErrorUpperBound(Long docCountErrorUpperBound)	Maximum number of missing documents when a bucket's count is very large and may exceed the shard size of Elasticsearch.
AggregationBucketResult.AggregationBucketResultBuilder	sumOtherDocCount(Long sumOtherDocCount)	When there are many unique terms, only the top terms are returned.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

docCountErrorUpperBound

public AggregationBucketResult.AggregationBucketResultBuilder docCountErrorUpperBound(Long docCountErrorUpperBound)

Maximum number of missing documents when a bucket's count is very large and may exceed the shard size of Elasticsearch. The larger this number, the more approximate the values of the counts in the buckets.

Returns:

this.

sumOtherDocCount

public AggregationBucketResult.AggregationBucketResultBuilder sumOtherDocCount(Long sumOtherDocCount)

When there are many unique terms, only the top terms are returned. This gives the sum of all document counts across all buckets that are NOT part of the response.

Returns:

this.

buckets

public AggregationBucketResult.AggregationBucketResultBuilder buckets(List<AggregationBucketDetails> buckets)

List of the top buckets that resulted from the aggregation.

Returns:

this.

build

public AggregationBucketResult build()

toString

public String toString()

Overrides:

toString in class Object