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

Class SignificantTermsAggregation

java.lang.Object

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

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

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

All Implemented Interfaces:

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

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

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final Query	backgroundFilter()	API name: background_filter
static SignificantTermsAggregation.Builder	builder()
final ChiSquareHeuristic	chiSquare()	API name: chi_square
boolean	equals(Object o)
final TermsExclude	exclude()	API name: exclude
final TermsAggregationExecutionHint	executionHint()	API name: execution_hint
final String	field()	API name: field
final GoogleNormalizedDistanceHeuristic	gnd()	API name: gnd
int	hashCode()
final TermsInclude	include()	API name: include
final EmptyObject	jlh()	API name: jlh
final Long	minDocCount()	Only return terms that are found in more than min_doc_count hits.
final MutualInformationHeuristic	mutualInformation()	API name: mutual_information
static SignificantTermsAggregation	of(Function<SignificantTermsAggregation.Builder,ObjectBuilder<SignificantTermsAggregation>> fn)
final PercentageScoreHeuristic	percentage()	API name: percentage
final ScriptedHeuristic	scriptHeuristic()	API name: script_heuristic
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSignificantTermsAggregationDeserializer(ObjectDeserializer<SignificantTermsAggregation.Builder> op)
final Long	shardMinDocCount()	Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count.
final Integer	shardSize()	Can be used to control the volumes of candidate terms produced by each shard.
final Integer	size()	The number of buckets returned out of the overall terms list.
SignificantTermsAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

Json deserializer for SignificantTermsAggregation

Method Details

of

public static SignificantTermsAggregation of(Function<SignificantTermsAggregation.Builder,ObjectBuilder<SignificantTermsAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

backgroundFilter

@Nullable
public final Query backgroundFilter()

API name: background_filter

chiSquare

@Nullable
public final ChiSquareHeuristic chiSquare()

API name: chi_square

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

gnd

@Nullable
public final GoogleNormalizedDistanceHeuristic gnd()

API name: gnd

include

@Nullable
public final TermsInclude include()

API name: include

jlh

@Nullable
public final EmptyObject jlh()

API name: jlh

minDocCount

@Nullable
public final Long minDocCount()

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

API name: min_doc_count

mutualInformation

@Nullable
public final MutualInformationHeuristic mutualInformation()

API name: mutual_information

percentage

@Nullable
public final PercentageScoreHeuristic percentage()

API name: percentage

scriptHeuristic

@Nullable
public final ScriptedHeuristic scriptHeuristic()

API name: script_heuristic

shardMinDocCount

@Nullable
public final Long shardMinDocCount()

Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count.

API name: shard_min_doc_count

shardSize

@Nullable
public final Integer shardSize()

Can be used to control the volumes 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

size

@Nullable
public final Integer size()

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

API name: size

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static SignificantTermsAggregation.Builder builder()

setupSignificantTermsAggregationDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase