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

Class TermsAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation

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

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

All Implemented Interfaces:

ToJsonp

public final class TermsAggregation
extends BucketAggregationBase

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TermsAggregation(TermsAggregation.Builder builder)

Method Summary

Modifier and Type	Method	Description
jakarta.json.JsonValue	collectMode()	API name: collect_mode
java.util.List<java.lang.String>	exclude()	API name: exclude
jakarta.json.JsonValue	executionHint()	API name: execution_hint
java.lang.String	field()	API name: field
jakarta.json.JsonValue	include()	API name: include
java.lang.Number	minDocCount()	API name: min_doc_count
jakarta.json.JsonValue	missing()	API name: missing
java.lang.Boolean	missingBucket()	API name: missing_bucket
jakarta.json.JsonValue	order()	API name: order
jakarta.json.JsonValue	script()	API name: script
protected static void	setupTermsAggregationDeserializer(DelegatingDeserializer<TermsAggregation.Builder> op)
java.lang.Number	shardSize()	API name: shard_size
java.lang.Boolean	showTermDocCountError()	API name: show_term_doc_count_error
java.lang.Number	size()	API name: size
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.String	valueType()	API name: value_type

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

aggregations, setupBucketAggregationBaseDeserializer

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

meta, name, setupAggregationDeserializer, toJsonp

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<TermsAggregation> DESERIALIZER

Json deserializer for TermsAggregation

Constructor Details

TermsAggregation

protected TermsAggregation(TermsAggregation.Builder builder)

Method Details

collectMode

@Nullable public jakarta.json.JsonValue collectMode()

API name: collect_mode

exclude

@Nullable public java.util.List<java.lang.String> exclude()

API name: exclude

executionHint

@Nullable public jakarta.json.JsonValue executionHint()

API name: execution_hint

field

@Nullable public java.lang.String field()

API name: field

include

@Nullable public jakarta.json.JsonValue include()

API name: include

minDocCount

@Nullable public java.lang.Number minDocCount()

API name: min_doc_count

missing

@Nullable public jakarta.json.JsonValue missing()

API name: missing

missingBucket

@Nullable public java.lang.Boolean missingBucket()

API name: missing_bucket

valueType

@Nullable public java.lang.String valueType()

API name: value_type

order

@Nullable public jakarta.json.JsonValue order()

API name: order

script

@Nullable public jakarta.json.JsonValue script()

API name: script

shardSize

@Nullable public java.lang.Number shardSize()

API name: shard_size

showTermDocCountError

@Nullable public java.lang.Boolean showTermDocCountError()

API name: show_term_doc_count_error

size

@Nullable public java.lang.Number size()

API name: size

toJsonpInternal

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

Overrides:

toJsonpInternal in class BucketAggregationBase

setupTermsAggregationDeserializer

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