Package org.opensearch.client.opensearch._types.aggregations

Class MultiTermsAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<MultiTermsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<MultiTermsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.MultiTermsAggregation.Builder

All Implemented Interfaces:

CopyableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation>, MutableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation>, ObjectBuilder<MultiTermsAggregation>

Enclosing class:

MultiTermsAggregation

public static class MultiTermsAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<MultiTermsAggregation.Builder>
implements CopyableBuilder<MultiTermsAggregation.Builder,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)	API name: collect_mode
MultiTermsAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MultiTermsAggregation.Builder	minDocCount(Integer value)	The minimum number of documents in a bucket for it to be returned.
final MultiTermsAggregation.Builder	order(Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)	API name: order
final MultiTermsAggregation.Builder	order(HistogramOrder value)	API name: order
protected MultiTermsAggregation.Builder	self()
final MultiTermsAggregation.Builder	shardMinDocCount(Integer 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(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.
final MultiTermsAggregation.Builder	terms(MultiTermLookup value, MultiTermLookup... values)	Required - The field from which to generate sets of terms.

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public MultiTermsAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected MultiTermsAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<MultiTermsAggregation.Builder>

collectMode

@Nonnull
public final MultiTermsAggregation.Builder collectMode(@Nullable
 TermsAggregationCollectMode value)

API name: collect_mode

minDocCount

@Nonnull
public final MultiTermsAggregation.Builder minDocCount(@Nullable
 Integer value)

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

API name: min_doc_count

order

@Nonnull
public final MultiTermsAggregation.Builder order(@Nullable
 HistogramOrder value)

API name: order

order

@Nonnull
public final MultiTermsAggregation.Builder order(Function<HistogramOrder.Builder,ObjectBuilder<HistogramOrder>> fn)

API name: order

shardMinDocCount

@Nonnull
public final MultiTermsAggregation.Builder shardMinDocCount(@Nullable
 Integer value)

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

API name: shard_min_doc_count

shardSize

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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.

build

@Nonnull
public MultiTermsAggregation build()

Builds a MultiTermsAggregation.

Specified by:

build in interface ObjectBuilder<MultiTermsAggregation>

Throws:

NullPointerException - if some of the required fields are null.