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

Class MultiTermsAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class MultiTermsAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiTermsAggregation.Builder	Builder for MultiTermsAggregation.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<MultiTermsAggregation>	_DESERIALIZER	Json deserializer for MultiTermsAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static MultiTermsAggregation.Builder	builder()
final TermsAggregationCollectMode	collectMode()	API name: collect_mode
boolean	equals(Object o)
int	hashCode()
final Integer	minDocCount()	The minimum number of documents in a bucket for it to be returned.
static MultiTermsAggregation	of(Function<MultiTermsAggregation.Builder,ObjectBuilder<MultiTermsAggregation>> fn)
final HistogramOrder	order()	API name: order
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupMultiTermsAggregationDeserializer(ObjectDeserializer<MultiTermsAggregation.Builder> op)
final Integer	shardMinDocCount()	The minimum number of documents in a bucket on each shard for it to be returned.
final Integer	shardSize()	The number of candidate terms produced by each shard.
final Boolean	showTermDocCountError()	Calculates the doc count error on per term basis.
final Integer	size()	The number of term buckets should be returned out of the overall terms list.
final List<MultiTermLookup>	terms()	Required - The field from which to generate sets of terms.
MultiTermsAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

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

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<MultiTermsAggregation> _DESERIALIZER

Json deserializer for MultiTermsAggregation

Method Details

of

public static MultiTermsAggregation of(Function<MultiTermsAggregation.Builder,ObjectBuilder<MultiTermsAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

collectMode

@Nullable
public final TermsAggregationCollectMode collectMode()

API name: collect_mode

minDocCount

@Nullable
public final Integer minDocCount()

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

API name: min_doc_count

order

@Nullable
public final HistogramOrder order()

API name: order

shardMinDocCount

@Nullable
public final Integer shardMinDocCount()

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

API name: shard_min_doc_count

shardSize

@Nullable
public final Integer shardSize()

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

@Nullable
public final Boolean showTermDocCountError()

Calculates the doc count error on per term basis.

API name: show_term_doc_count_error

size

@Nullable
public final Integer size()

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

API name: size

terms

@Nonnull
public final List<MultiTermLookup> terms()

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

API name: terms

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class AggregationBase

toBuilder

@Nonnull
public MultiTermsAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MultiTermsAggregation.Builder,MultiTermsAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static MultiTermsAggregation.Builder builder()

setupMultiTermsAggregationDeserializer

protected static void setupMultiTermsAggregationDeserializer(ObjectDeserializer<MultiTermsAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase