com.arakelian.elastic.model.aggs.bucket

Interface TermsAggregation

All Superinterfaces:

Aggregation, BucketAggregation, java.io.Serializable, ValuesSourceAggregation

@Value.Immutable(copy=false)
public interface TermsAggregation
extends BucketAggregation, ValuesSourceAggregation

See Also:

Terms Aggregation, TermsAggregationBuilder.java

Field Summary

Fields inherited from interface com.arakelian.elastic.model.aggs.Aggregation

ADJACENCY_MATRIX_AGGREGATION, AVG_AGGREGATION, CARDINALITY_AGGREGATION, DATE_HISTOGRAM_AGGREGATION, DATE_RANGE_AGGREGATION, EXTENDED_STATS_AGGREGATION, FILTER_AGGREGATION, FILTERS_AGGREGATION, GEO_BOUNDS_AGGREGATION, GEO_CENTROID_AGGREGATION, GEO_DISTANCE_AGGREGATION, GEOHASH_GRID_AGGREGATION, GLOBAL_AGGREGATION, HISTOGRAM_AGGREGATION, IP_RANGE_AGGREGATION, MAX_AGGREGATION, MIN_AGGREGATION, MISSING_AGGREGATION, NESTED_AGGREGATION, PERCENTILE_RANKS_AGGREGATION, PERCENTILES_AGGREGATION, RANGE_AGGREGATION, REVERSE_NESTED_AGGREGATION, SAMPLER_AGGREGATION, SIGNIFICANT_TERMS_AGGREGATION, SIGNIFICANT_TEXT_AGGREGATION, STATS_AGGREGATION, SUM_AGGREGATION, TERMS_AGGREGATION, VALUE_COUNT_AGGREGATION

Method Summary

Modifier and Type	Method and Description
default void	accept(AggregationVisitor visitor)
CollectMode	getCollectMode()
default java.util.List<java.lang.Object>	getExclude()
ExecutionHint	getExecutionHint() Returns the mechanism by which terms aggregation is executed.
default java.util.List<java.lang.Object>	getInclude()
java.lang.Long	getMinDocCount() Returns the minimum number of hits required before returning a term.
default java.util.List<BucketOrder>	getOrder() Returns the bucket order.
java.lang.Long	getShardMinDocCount() Returns the minimum number of hits required on a local shard before a term is returned.
java.lang.Long	getShardSize() Returns how many terms the coordinating node will request from each shard.
java.lang.Integer	getSize() Returns how many term buckets should be returned out of the overall terms list.
java.lang.Boolean	isShowTermDocCountError()

Methods inherited from interface com.arakelian.elastic.model.aggs.Aggregation

countNotEmpty, getName, getSubAggregations, isEmpty

Methods inherited from interface com.arakelian.elastic.model.aggs.ValuesSourceAggregation

getField, getFormat, getMissing, getTimeZone

Method Detail

getCollectMode

CollectMode getCollectMode()

getExclude

@Value.Default
default java.util.List<java.lang.Object> getExclude()

getExecutionHint

ExecutionHint getExecutionHint()

Returns the mechanism by which terms aggregation is executed.

Returns:

the mechanism by which terms aggregation is executed.

getInclude

@Value.Default
default java.util.List<java.lang.Object> getInclude()

getMinDocCount

java.lang.Long getMinDocCount()

Returns the minimum number of hits required before returning a term.

Returns:

the minimum number of hits required before returning a term.

getOrder

@Value.Default
default java.util.List<BucketOrder> getOrder()

Returns the bucket order.

Returns:

the bucket order

See Also:

InternalOrder.java

getShardMinDocCount

java.lang.Long getShardMinDocCount()

Returns the minimum number of hits required on a local shard before a term is returned.

Returns:

the minimum number of hits required on a local shard before a term is returned.

getShardSize

java.lang.Long getShardSize()

Returns how many terms the coordinating node will request from each shard. Once all the shards responded, the coordinating node will then reduce them to a final result which will be based on the size parameter - this way, one can increase the accuracy of the returned terms and avoid the overhead of streaming a big list of buckets back to the client.

Returns:

the number of terms the coordinating node will request from each shard.

getSize

java.lang.Integer getSize()

Returns how many term buckets should be returned out of the overall terms list. By default, the node coordinating the search process will request each shard to provide its own top size term buckets and once all shards respond, it will reduce the results to the final list that will then be returned to the client.

Returns:

how many term buckets should be returned out of the overall terms list.

isShowTermDocCountError

java.lang.Boolean isShowTermDocCountError()

accept

default void accept(AggregationVisitor visitor)

Specified by:

accept in interface Aggregation