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

Class TermsAggregation

java.lang.Object

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

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

org.opensearch.client.opensearch._types.aggregations.TermsAggregation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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<TermsAggregation>	_DESERIALIZER	Json deserializer for TermsAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static TermsAggregation.Builder	builder()
final TermsAggregationCollectMode	collectMode()	API name: collect_mode
boolean	equals(Object o)
final TermsExclude	exclude()	API name: exclude
final TermsAggregationExecutionHint	executionHint()	API name: execution_hint
final String	field()	API name: field
final String	format()	API name: format
int	hashCode()
final TermsInclude	include()	API name: include
final Integer	minDocCount()	Only return values that are found in more than min_doc_count hits.
final FieldValue	missing()	API name: missing
final Boolean	missingBucket()	API name: missing_bucket
final MissingOrder	missingOrder()	API name: missing_order
static TermsAggregation	of(Function<TermsAggregation.Builder,ObjectBuilder<TermsAggregation>> fn)
final List<Map<String,SortOrder>>	order()	API name: order
final Script	script()	API name: script
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTermsAggregationDeserializer(ObjectDeserializer<TermsAggregation.Builder> op)
final Integer	shardSize()	The number of candidate terms produced by each shard.
final Boolean	showTermDocCountError()	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 Integer	size()	The number of buckets returned out of the overall terms list.
TermsAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	valueType()	Coerced unmapped fields into the specified type.

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<TermsAggregation> _DESERIALIZER

Json deserializer for TermsAggregation

Method Details

of

public static TermsAggregation of(Function<TermsAggregation.Builder,ObjectBuilder<TermsAggregation>> 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

exclude

@Nullable
public final TermsExclude exclude()

API name: exclude

executionHint

@Nullable
public final TermsAggregationExecutionHint executionHint()

API name: execution_hint

field

@Nullable
public final String field()

API name: field

format

@Nullable
public final String format()

API name: format

include

@Nullable
public final TermsInclude include()

API name: include

minDocCount

@Nullable
public final Integer minDocCount()

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

API name: min_doc_count

missing

@Nullable
public final FieldValue missing()

API name: missing

missingBucket

@Nullable
public final Boolean missingBucket()

API name: missing_bucket

missingOrder

@Nullable
public final MissingOrder missingOrder()

API name: missing_order

order

@Nonnull
public final List<Map<String,SortOrder>> order()

API name: order

script

@Nullable
public final Script script()

API name: script

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()

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

@Nullable
public final Integer size()

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

API name: size

valueType

@Nullable
public final String valueType()

Coerced unmapped fields into the specified type.

API name: value_type

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

@Nonnull
public TermsAggregation.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<TermsAggregation.Builder,TermsAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static TermsAggregation.Builder builder()

setupTermsAggregationDeserializer

protected static void setupTermsAggregationDeserializer(ObjectDeserializer<TermsAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase