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

Class SignificantTermsAggregation

java.lang.Object

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

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

org.opensearch.client.opensearch._types.aggregations.SignificantTermsAggregation

All Implemented Interfaces:

ToJsonp

public final class SignificantTermsAggregation
extends BucketAggregationBase

Nested Class Summary

Nested Classes

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

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<SignificantTermsAggregation>	DESERIALIZER	Json deserializer for SignificantTermsAggregation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SignificantTermsAggregation(SignificantTermsAggregation.Builder builder)

Method Summary

Modifier and Type	Method	Description
QueryContainer	backgroundFilter()	API name: background_filter
ChiSquareHeuristic	chiSquare()	API name: chi_square
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
GoogleNormalizedDistanceHeuristic	gnd()	API name: gnd
java.util.List<java.lang.String>	include()	API name: include
java.lang.Number	minDocCount()	API name: min_doc_count
MutualInformationHeuristic	mutualInformation()	API name: mutual_information
jakarta.json.JsonValue	percentage()	API name: percentage
ScriptedHeuristic	scriptHeuristic()	API name: script_heuristic
protected static void	setupSignificantTermsAggregationDeserializer(DelegatingDeserializer<SignificantTermsAggregation.Builder> op)
java.lang.Number	shardMinDocCount()	API name: shard_min_doc_count
java.lang.Number	shardSize()	API name: shard_size
java.lang.Number	size()	API name: size
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

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<SignificantTermsAggregation> DESERIALIZER

Json deserializer for SignificantTermsAggregation

Constructor Details

SignificantTermsAggregation

protected SignificantTermsAggregation(SignificantTermsAggregation.Builder builder)

Method Details

backgroundFilter

@Nullable public QueryContainer backgroundFilter()

API name: background_filter

chiSquare

@Nullable public ChiSquareHeuristic chiSquare()

API name: chi_square

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

gnd

@Nullable public GoogleNormalizedDistanceHeuristic gnd()

API name: gnd

include

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

API name: include

minDocCount

@Nullable public java.lang.Number minDocCount()

API name: min_doc_count

mutualInformation

@Nullable public MutualInformationHeuristic mutualInformation()

API name: mutual_information

percentage

@Nullable public jakarta.json.JsonValue percentage()

API name: percentage

scriptHeuristic

@Nullable public ScriptedHeuristic scriptHeuristic()

API name: script_heuristic

shardMinDocCount

@Nullable public java.lang.Number shardMinDocCount()

API name: shard_min_doc_count

shardSize

@Nullable public java.lang.Number shardSize()

API name: shard_size

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

setupSignificantTermsAggregationDeserializer

protected static void setupSignificantTermsAggregationDeserializer(DelegatingDeserializer<SignificantTermsAggregation.Builder> op)