Package org.opensearch.search.aggregations.bucket.terms

Class SignificantTermsAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

org.opensearch.search.aggregations.AbstractAggregationBuilder<AB>

org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

org.opensearch.search.aggregations.bucket.terms.SignificantTermsAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class SignificantTermsAggregationBuilder
extends ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

Aggregation Builder for significant terms agg

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final ValuesSourceRegistry.RegistryKey<org.opensearch.search.aggregations.bucket.terms.SignificantTermsAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

Fields inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

metadata

Fields inherited from class org.opensearch.search.aggregations.AggregationBuilder

factoriesBuilder, name

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	SignificantTermsAggregationBuilder(String name)
	SignificantTermsAggregationBuilder(StreamInput in)	Read from a Stream.
protected	SignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
QueryBuilder	backgroundFilter()
SignificantTermsAggregationBuilder	backgroundFilter(QueryBuilder backgroundFilter)
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
TermsAggregator.BucketCountThresholds	bucketCountThresholds()
SignificantTermsAggregationBuilder	bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected AggregationBuilder	doRewrite(QueryRewriteContext queryShardContext)	Rewrites this aggregation builder into its primitive form.
protected org.opensearch.common.xcontent.XContentBuilder	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
String	executionHint()	Expert: gets an execution hint to the aggregation.
SignificantTermsAggregationBuilder	executionHint(String executionHint)	Expert: sets an execution hint to the aggregation.
protected TermsAggregator.BucketCountThresholds	getBucketCountThresholds()
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
IncludeExclude	includeExclude()	Get terms to include and exclude from the aggregation results
SignificantTermsAggregationBuilder	includeExclude(IncludeExclude includeExclude)	Set terms to include and exclude from the aggregation results
protected ValuesSourceAggregatorFactory	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
SignificantTermsAggregationBuilder	minDocCount(long minDocCount)	Set the minimum document count terms should have in order to appear in the response.
static SignificantTermsAggregationBuilder	parse(String aggregationName, org.opensearch.common.xcontent.XContentParser parser)
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected boolean	serializeTargetValueType(Version version)	DO NOT OVERRIDE THIS! This method only exists for legacy support.
protected SignificantTermsAggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
SignificantTermsAggregationBuilder	shardMinDocCount(long shardMinDocCount)	Set the minimum document count terms should have on the shard in order to appear in the response.
SignificantTermsAggregationBuilder	shardSize(int shardSize)	Sets the shard_size - indicating the number of term buckets each shard will return to the coordinating node (the node that coordinates the search execution).
SignificanceHeuristic	significanceHeuristic()
SignificantTermsAggregationBuilder	significanceHeuristic(SignificanceHeuristic significanceHeuristic)
SignificantTermsAggregationBuilder	size(int size)	Sets the size - indicating how many term buckets should be returned (defaults to 10)

Methods inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, timeZone, timeZone, userValueTypeHint, userValueTypeHint

Methods inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.opensearch.search.aggregations.AggregationBuilder

buildPipelineTree, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

REGISTRY_KEY

public static final ValuesSourceRegistry.RegistryKey<org.opensearch.search.aggregations.bucket.terms.SignificantTermsAggregatorSupplier> REGISTRY_KEY

Constructor Details

SignificantTermsAggregationBuilder

public SignificantTermsAggregationBuilder(String name)

SignificantTermsAggregationBuilder

public SignificantTermsAggregationBuilder(StreamInput in)
                                   throws IOException

Read from a Stream.

Throws:

IOException

SignificantTermsAggregationBuilder

protected SignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Method Details

parse

public static SignificantTermsAggregationBuilder parse(String aggregationName,
 org.opensearch.common.xcontent.XContentParser parser)
                                                throws IOException

Throws:

IOException

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: ValuesSourceAggregationBuilder

Aggregations should use this method to define a ValuesSourceType of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

shallowCopy

protected SignificantTermsAggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

doRewrite

protected AggregationBuilder doRewrite(QueryRewriteContext queryShardContext)
                                throws IOException

Description copied from class: AggregationBuilder

Rewrites this aggregation builder into its primitive form. By default this method return the builder itself. If the builder did not change the identity reference must be returned otherwise the builder will be rewritten infinitely.

Overrides:

doRewrite in class AggregationBuilder

Throws:

IOException

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

Throws:

IOException

serializeTargetValueType

protected boolean serializeTargetValueType(Version version)

Description copied from class: ValuesSourceAggregationBuilder

DO NOT OVERRIDE THIS! This method only exists for legacy support. No new aggregations need this, nor should they override it.

Overrides:

serializeTargetValueType in class ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

Parameters:

version - For backwards compatibility, subclasses can change behavior based on the version

getBucketCountThresholds

protected TermsAggregator.BucketCountThresholds getBucketCountThresholds()

bucketCountThresholds

public TermsAggregator.BucketCountThresholds bucketCountThresholds()

bucketCountThresholds

public SignificantTermsAggregationBuilder bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)

size

public SignificantTermsAggregationBuilder size(int size)

Sets the size - indicating how many term buckets should be returned (defaults to 10)

shardSize

public SignificantTermsAggregationBuilder shardSize(int shardSize)

Sets the shard_size - indicating the number of term buckets each shard will return to the coordinating node (the node that coordinates the search execution). The higher the shard size is, the more accurate the results are.

minDocCount

public SignificantTermsAggregationBuilder minDocCount(long minDocCount)

Set the minimum document count terms should have in order to appear in the response.

shardMinDocCount

public SignificantTermsAggregationBuilder shardMinDocCount(long shardMinDocCount)

Set the minimum document count terms should have on the shard in order to appear in the response.

executionHint

public SignificantTermsAggregationBuilder executionHint(String executionHint)

Expert: sets an execution hint to the aggregation.

executionHint

public String executionHint()

Expert: gets an execution hint to the aggregation.

backgroundFilter

public SignificantTermsAggregationBuilder backgroundFilter(QueryBuilder backgroundFilter)

backgroundFilter

public QueryBuilder backgroundFilter()

includeExclude

public SignificantTermsAggregationBuilder includeExclude(IncludeExclude includeExclude)

Set terms to include and exclude from the aggregation results

includeExclude

public IncludeExclude includeExclude()

Get terms to include and exclude from the aggregation results

significanceHeuristic

public SignificantTermsAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic)

significanceHeuristic

public SignificanceHeuristic significanceHeuristic()

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

innerBuild

protected ValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                            throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

Throws:

IOException

doXContentBody

protected org.opensearch.common.xcontent.XContentBuilder doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                                 throws IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>