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

Class MultiTermsAggregation.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<MultiTermsAggregation.Builder>

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

All Implemented Interfaces:

WithJson<MultiTermsAggregation.Builder>, ObjectBuilder<MultiTermsAggregation>

Enclosing class:

MultiTermsAggregation

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

Builder for MultiTermsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MultiTermsAggregation	build()	Builds a MultiTermsAggregation.
final MultiTermsAggregation.Builder	collectMode(TermsAggregationCollectMode value)	Specifies the strategy for data collection.
final MultiTermsAggregation.Builder	minDocCount(Long value)	The minimum number of documents in a bucket for it to be returned.
final MultiTermsAggregation.Builder	order(NamedValue<SortOrder> value, NamedValue<SortOrder>... values)	Specifies the sort order of the buckets.
final MultiTermsAggregation.Builder	order(List<NamedValue<SortOrder>> list)	Specifies the sort order of the buckets.
protected MultiTermsAggregation.Builder	self()
final MultiTermsAggregation.Builder	shardMinDocCount(Long value)	The minimum number of documents in a bucket on each shard for it to be returned.
final MultiTermsAggregation.Builder	shardSize(Integer value)	The number of candidate terms produced by each shard.
final MultiTermsAggregation.Builder	showTermDocCountError(Boolean value)	Calculates the doc count error on per term basis.
final MultiTermsAggregation.Builder	size(Integer value)	The number of term buckets should be returned out of the overall terms list.
final MultiTermsAggregation.Builder	terms(MultiTermLookup value, MultiTermLookup... values)	Required - The field from which to generate sets of terms.
final MultiTermsAggregation.Builder	terms(Function<MultiTermLookup.Builder,ObjectBuilder<MultiTermLookup>> fn)	Required - The field from which to generate sets of terms.
final MultiTermsAggregation.Builder	terms(List<MultiTermLookup> list)	Required - The field from which to generate sets of terms.

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

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 MultiTermsAggregation.Builder collectMode(@Nullable
 TermsAggregationCollectMode value)

Specifies the strategy for data collection.

API name: collect_mode

order

public final MultiTermsAggregation.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 MultiTermsAggregation.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.

minDocCount

public final MultiTermsAggregation.Builder minDocCount(@Nullable
 Long value)

The minimum number of documents in a bucket for it to be returned.

API name: min_doc_count

shardMinDocCount

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

The minimum number of documents in a bucket on each shard for it to be returned.

API name: shard_min_doc_count

shardSize

public final MultiTermsAggregation.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 MultiTermsAggregation.Builder showTermDocCountError(@Nullable
 Boolean value)

Calculates the doc count error on per term basis.

API name: show_term_doc_count_error

size

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

The number of term buckets should be returned out of the overall terms list.

API name: size

terms

public final MultiTermsAggregation.Builder terms(List<MultiTermLookup> list)

Required - The field from which to generate sets of terms.

API name: terms

Adds all elements of list to terms.

terms

public final MultiTermsAggregation.Builder terms(MultiTermLookup value,
 MultiTermLookup... values)

Required - The field from which to generate sets of terms.

API name: terms

Adds one or more values to terms.

terms

public final MultiTermsAggregation.Builder terms(Function<MultiTermLookup.Builder,ObjectBuilder<MultiTermLookup>> fn)

Required - The field from which to generate sets of terms.

API name: terms

Adds a value to terms using a builder lambda.

self

protected MultiTermsAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<MultiTermsAggregation.Builder>

build

public MultiTermsAggregation build()

Builds a MultiTermsAggregation.

Specified by:

build in interface ObjectBuilder<MultiTermsAggregation>

Throws:

NullPointerException - if some of the required fields are null.