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

Class RareTermsAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

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

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

org.opensearch.search.aggregations.bucket.terms.RareTermsAggregationBuilder

All Implemented Interfaces:

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

public class RareTermsAggregationBuilder
extends ValuesSourceAggregationBuilder<RareTermsAggregationBuilder>

Aggregation Builder for rare_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.core.xcontent.ToXContent

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

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final org.opensearch.core.xcontent.ObjectParser<RareTermsAggregationBuilder,String>	PARSER
static final ValuesSourceRegistry.RegistryKey<org.opensearch.search.aggregations.bucket.terms.RareTermsAggregatorSupplier>	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.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RareTermsAggregationBuilder(String name)
RareTermsAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
double	getPrecision()	Get the current false positive rate for individual cuckoo filters.
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
RareTermsAggregationBuilder	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(org.opensearch.core.common.io.stream.StreamOutput out)	Write subclass's state to the stream.
RareTermsAggregationBuilder	maxDocCount(long maxDocCount)	Set the maximum document count terms should have in order to appear in the response.
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected boolean	serializeTargetValueType(org.opensearch.Version version)	DO NOT OVERRIDE THIS!
void	setPrecision(double precision)	Set's the false-positive rate for individual cuckoo filters.
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

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, doRewrite, 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.core.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.RareTermsAggregatorSupplier> REGISTRY_KEY

PARSER

public static final org.opensearch.core.xcontent.ObjectParser<RareTermsAggregationBuilder,String> PARSER

Constructor Details

RareTermsAggregationBuilder

public RareTermsAggregationBuilder(String name)

RareTermsAggregationBuilder

public RareTermsAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                            throws IOException

Read from a stream.

Throws:

IOException

Method Details

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<RareTermsAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

shallowCopy

protected AggregationBuilder 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

serializeTargetValueType

protected boolean serializeTargetValueType(org.opensearch.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<RareTermsAggregationBuilder>

Parameters:

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

innerWriteTo

protected void innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                     throws IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<RareTermsAggregationBuilder>

Throws:

IOException

maxDocCount

public RareTermsAggregationBuilder maxDocCount(long maxDocCount)

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

includeExclude

public RareTermsAggregationBuilder 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

getPrecision

public double getPrecision()

Get the current false positive rate for individual cuckoo filters.

setPrecision

public void setPrecision(double precision)

Set's the false-positive rate for individual cuckoo filters. Does not dictate the overall fpp rate since we use a "scaling" cuckoo filter which adds more filters as required, and the overall error rate grows differently than individual filters

This value does, however, affect the overall space usage of the filter. Coarser precisions provide more compact filters. The default is 0.01

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<RareTermsAggregationBuilder>

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<RareTermsAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<RareTermsAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<RareTermsAggregationBuilder>

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<RareTermsAggregationBuilder>