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, AggregationVariant

@JsonpDeserializable
public class TermsAggregation
extends BucketAggregationBase
implements AggregationVariant

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Aggregation.Kind`	`_aggregationKind()`	Aggregation variant kind.
`TermsAggregationCollectMode`	`collectMode()`	API name: `collect_mode`
`TermsExclude`	`exclude()`	API name: `exclude`
`TermsAggregationExecutionHint`	`executionHint()`	API name: `execution_hint`
`java.lang.String`	`field()`	API name: `field`
`TermsInclude`	`include()`	API name: `include`
`java.lang.Integer`	`minDocCount()`	API name: `min_doc_count`
`FieldValue`	`missing()`	API name: `missing`
`java.lang.Boolean`	`missingBucket()`	API name: `missing_bucket`
`MissingOrder`	`missingOrder()`	API name: `missing_order`
`static TermsAggregation`	`of(java.util.function.Function<TermsAggregation.Builder,ObjectBuilder<TermsAggregation>> fn)`
`java.util.List<java.util.Map<java.lang.String,SortOrder>>`	`order()`	API name: `order`
`Script`	`script()`	API name: `script`
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupTermsAggregationDeserializer(ObjectDeserializer<TermsAggregation.Builder> op)`
`java.lang.Integer`	`shardSize()`	API name: `shard_size`
`java.lang.Boolean`	`showTermDocCountError()`	API name: `show_term_doc_count_error`
`java.lang.Integer`	`size()`	API name: `size`
`java.lang.String`	`valueType()`	API name: `value_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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<TermsAggregation> _DESERIALIZER

Json deserializer for TermsAggregation

Method Detail

of

public static TermsAggregation of(java.util.function.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 java.lang.String field()

API name: field

include

@Nullable
public final TermsInclude include()

API name: include

minDocCount

@Nullable
public final java.lang.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 java.lang.Boolean missingBucket()

API name: missing_bucket

valueType

@Nullable
public final java.lang.String valueType()

API name: value_type

order

public final java.util.List<java.util.Map<java.lang.String,SortOrder>> order()

API name: order

script

@Nullable
public final Script script()

API name: script

shardSize

@Nullable
public final java.lang.Integer shardSize()

API name: shard_size

showTermDocCountError

@Nullable
public final java.lang.Boolean showTermDocCountError()

API name: show_term_doc_count_error

size

@Nullable
public final java.lang.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)

Class TermsAggregation

Nested Class Summary

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

Field Summary