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

Class TermsAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

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

All Implemented Interfaces:

AggregationVariant, PivotGroupByVariant, JsonpSerializable

@JsonpDeserializable
public class TermsAggregation
extends BucketAggregationBase
implements AggregationVariant, PivotGroupByVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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.
PivotGroupBy.Kind	_pivotGroupByKind()	PivotGroupBy variant kind.
final TermsAggregationCollectMode	collectMode()	API name: collect_mode
final TermsExclude	exclude()	API name: exclude
final TermsAggregationExecutionHint	executionHint()	API name: execution_hint
final String	field()	API name: field
final TermsInclude	include()	API name: include
final Integer	minDocCount()	API name: min_doc_count
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<NamedValue<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()	API name: shard_size
final Boolean	showTermDocCountError()	API name: show_term_doc_count_error
final Integer	size()	API name: size
final String	valueType()	API name: value_type

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

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

meta, name, serialize, setupAggregationBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Methods inherited from interface co.elastic.clients.elasticsearch.transform.PivotGroupByVariant

_toPivotGroupBy

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

_pivotGroupByKind

public PivotGroupBy.Kind _pivotGroupByKind()

PivotGroupBy variant kind.

Specified by:

_pivotGroupByKind in interface PivotGroupByVariant

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

include

@Nullable
public final TermsInclude include()

API name: include

minDocCount

@Nullable
public final Integer minDocCount()

API name: min_doc_count

missing

@Nullable
public final FieldValue missing()

API name: missing

missingOrder

@Nullable
public final MissingOrder missingOrder()

API name: missing_order

missingBucket

@Nullable
public final Boolean missingBucket()

API name: missing_bucket

valueType

@Nullable
public final String valueType()

API name: value_type

order

public final List<NamedValue<SortOrder>> order()

API name: order

script

@Nullable
public final Script script()

API name: script

shardSize

@Nullable
public final Integer shardSize()

API name: shard_size

showTermDocCountError

@Nullable
public final Boolean showTermDocCountError()

API name: show_term_doc_count_error

size

@Nullable
public final Integer size()

API name: size

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

setupTermsAggregationDeserializer

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