Package org.opensearch.search.aggregations.metrics

Class PercentilesAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

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

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

org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly<ValuesSource,PercentilesAggregationBuilder>

org.opensearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder<PercentilesAggregationBuilder>

org.opensearch.search.aggregations.metrics.PercentilesAggregationBuilder

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 PercentilesAggregationBuilder
extends AbstractPercentilesAggregationBuilder<PercentilesAggregationBuilder>

Aggregation Builder for percentiles 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 ValuesSourceRegistry.RegistryKey<PercentilesAggregatorSupplier>	REGISTRY_KEY

Fields inherited from class org.opensearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder

keyed, KEYED_FIELD, values

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

Modifier	Constructor	Description
	PercentilesAggregationBuilder(String name)
	PercentilesAggregationBuilder(String name, double[] values, PercentilesConfig percentilesConfig)
	PercentilesAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)
protected	PercentilesAggregationBuilder(PercentilesAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()	The name of the type of aggregation built by this builder.
protected ValuesSourceAggregatorFactory	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
static AggregationBuilder	parse(String aggregationName, org.opensearch.core.xcontent.XContentParser parser)
double[]	percentiles()	Get the values to compute percentiles from.
PercentilesAggregationBuilder	percentiles(double... percents)	Set the values to compute percentiles from.
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
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.metrics.AbstractPercentilesAggregationBuilder

compression, compression, createParser, doXContentBody, equals, hashCode, innerWriteTo, keyed, keyed, method, method, numberOfSignificantValueDigits, numberOfSignificantValueDigits, percentilesConfig, percentilesConfig

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

bucketCardinality, subAggregations

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

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

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

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, 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<PercentilesAggregatorSupplier> REGISTRY_KEY

Constructor Details

PercentilesAggregationBuilder

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

Throws:

IOException

PercentilesAggregationBuilder

public PercentilesAggregationBuilder(String name)

PercentilesAggregationBuilder

public PercentilesAggregationBuilder(String name,
 double[] values,
 PercentilesConfig percentilesConfig)

PercentilesAggregationBuilder

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

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

parse

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

Throws:

IOException

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

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

Returns:

The CoreValuesSourceType we expect this script to yield.

percentiles

public PercentilesAggregationBuilder percentiles(double... percents)

Set the values to compute percentiles from.

percentiles

public double[] percentiles()

Get the values to compute percentiles from.

innerBuild

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

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<PercentilesAggregationBuilder>

Throws:

IOException

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