Package co.elastic.clients.elasticsearch._types.aggregations

Class TermsAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<TermsAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.TermsAggregation.Builder

All Implemented Interfaces:

WithJson<TermsAggregation.Builder>, ObjectBuilder<TermsAggregation>

Enclosing class:

TermsAggregation

public static class TermsAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<TermsAggregation.Builder>
implements ObjectBuilder<TermsAggregation>

Builder for TermsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermsAggregation	build()	Builds a TermsAggregation.
final TermsAggregation.Builder	collectMode(TermsAggregationCollectMode value)	Determines how child aggregations should be calculated: breadth-first or depth-first.
final TermsAggregation.Builder	exclude(TermsExclude value)	Values to exclude.
final TermsAggregation.Builder	exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	Values to exclude.
final TermsAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	Determines whether the aggregation will use field values directly or global ordinals.
final TermsAggregation.Builder	field(String value)	The field from which to return terms.
final TermsAggregation.Builder	format(String value)	API name: format
final TermsAggregation.Builder	include(TermsInclude value)	Values to include.
final TermsAggregation.Builder	include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)	Values to include.
final TermsAggregation.Builder	minDocCount(Integer value)	Only return values that are found in more than min_doc_count hits.
final TermsAggregation.Builder	missing(boolean value)	The value to apply to documents that do not have a value.
final TermsAggregation.Builder	missing(double value)	The value to apply to documents that do not have a value.
final TermsAggregation.Builder	missing(long value)	The value to apply to documents that do not have a value.
final TermsAggregation.Builder	missing(FieldValue value)	The value to apply to documents that do not have a value.
final TermsAggregation.Builder	missing(String value)	The value to apply to documents that do not have a value.
final TermsAggregation.Builder	missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	The value to apply to documents that do not have a value.
final TermsAggregation.Builder	missingBucket(Boolean value)	API name: missing_bucket
final TermsAggregation.Builder	missingOrder(MissingOrder value)	API name: missing_order
final TermsAggregation.Builder	order(NamedValue<SortOrder> value, NamedValue<SortOrder>... values)	Specifies the sort order of the buckets.
final TermsAggregation.Builder	order(List<NamedValue<SortOrder>> list)	Specifies the sort order of the buckets.
final TermsAggregation.Builder	script(Script value)	API name: script
final TermsAggregation.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: script
protected TermsAggregation.Builder	self()
final TermsAggregation.Builder	shardMinDocCount(Long value)	Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count.
final TermsAggregation.Builder	shardSize(Integer value)	The number of candidate terms produced by each shard.
final TermsAggregation.Builder	showTermDocCountError(Boolean value)	Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard.
final TermsAggregation.Builder	size(Integer value)	The number of buckets returned out of the overall terms list.
final TermsAggregation.Builder	valueType(String value)	Coerced unmapped fields into the specified type.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

collectMode

public final TermsAggregation.Builder collectMode(@Nullable
 TermsAggregationCollectMode value)

Determines how child aggregations should be calculated: breadth-first or depth-first.

API name: collect_mode

exclude

public final TermsAggregation.Builder exclude(@Nullable
 TermsExclude value)

Values to exclude. Accepts regular expressions and partitions.

API name: exclude

exclude

public final TermsAggregation.Builder exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)

Values to exclude. Accepts regular expressions and partitions.

API name: exclude

executionHint

public final TermsAggregation.Builder executionHint(@Nullable
 TermsAggregationExecutionHint value)

Determines whether the aggregation will use field values directly or global ordinals.

API name: execution_hint

field

public final TermsAggregation.Builder field(@Nullable
 String value)

The field from which to return terms.

API name: field

include

public final TermsAggregation.Builder include(@Nullable
 TermsInclude value)

Values to include. Accepts regular expressions and partitions.

API name: include

include

public final TermsAggregation.Builder include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)

Values to include. Accepts regular expressions and partitions.

API name: include

minDocCount

public final TermsAggregation.Builder minDocCount(@Nullable
 Integer value)

Only return values that are found in more than min_doc_count hits.

API name: min_doc_count

missing

public final TermsAggregation.Builder missing(@Nullable
 FieldValue value)

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

missing

public final TermsAggregation.Builder missing(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

missing

public final TermsAggregation.Builder missing(String value)

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

missing

public final TermsAggregation.Builder missing(long value)

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

missing

public final TermsAggregation.Builder missing(double value)

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

missing

public final TermsAggregation.Builder missing(boolean value)

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

missingOrder

public final TermsAggregation.Builder missingOrder(@Nullable
 MissingOrder value)

API name: missing_order

missingBucket

public final TermsAggregation.Builder missingBucket(@Nullable
 Boolean value)

API name: missing_bucket

valueType

public final TermsAggregation.Builder valueType(@Nullable
 String value)

Coerced unmapped fields into the specified type.

API name: value_type

order

public final TermsAggregation.Builder order(List<NamedValue<SortOrder>> list)

Specifies the sort order of the buckets. Defaults to sorting by descending document count.

API name: order

Adds all elements of list to order.

order

public final TermsAggregation.Builder order(NamedValue<SortOrder> value,
 NamedValue<SortOrder>... values)

Specifies the sort order of the buckets. Defaults to sorting by descending document count.

API name: order

Adds one or more values to order.

script

public final TermsAggregation.Builder script(@Nullable
 Script value)

API name: script

script

public final TermsAggregation.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: script

shardMinDocCount

public final TermsAggregation.Builder shardMinDocCount(@Nullable
 Long value)

Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count.

API name: shard_min_doc_count

shardSize

public final TermsAggregation.Builder shardSize(@Nullable
 Integer value)

The number of candidate terms produced by each shard. By default, shard_size will be automatically estimated based on the number of shards and the size parameter.

API name: shard_size

showTermDocCountError

public final TermsAggregation.Builder showTermDocCountError(@Nullable
 Boolean value)

Set to true to return the doc_count_error_upper_bound, which is an upper bound to the error on the doc_count returned by each shard.

API name: show_term_doc_count_error

size

public final TermsAggregation.Builder size(@Nullable
 Integer value)

The number of buckets returned out of the overall terms list.

API name: size

format

public final TermsAggregation.Builder format(@Nullable
 String value)

API name: format

self

protected TermsAggregation.Builder self()

Specified by:

self in class BucketAggregationBase.AbstractBuilder<TermsAggregation.Builder>

build

public TermsAggregation build()

Builds a TermsAggregation.

Specified by:

build in interface ObjectBuilder<TermsAggregation>

Throws:

NullPointerException - if some of the required fields are null.