Package org.elasticsearch.search.aggregations.metrics

Class AbstractPercentilesAggregationBuilder<T extends AbstractPercentilesAggregationBuilder<T>>

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly<ValuesSource,T>

org.elasticsearch.search.aggregations.metrics.AbstractPercentilesAggregationBuilder<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

PercentileRanksAggregationBuilder, PercentilesAggregationBuilder

public abstract class AbstractPercentilesAggregationBuilder<T extends AbstractPercentilesAggregationBuilder<T>>
extends ValuesSourceAggregationBuilder.LeafOnly<ValuesSource,T>

This provides a base class for aggregations that are building percentiles or percentiles-like functionality (e.g. percentile ranks). It provides a set of common fields/functionality for setting the available algorithms (TDigest and HDRHistogram), as well as algorithm-specific settings via a PercentilesConfig object

Nested Class Summary

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

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

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	keyed
static org.elasticsearch.common.xcontent.ParseField	KEYED_FIELD
protected double[]	values

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

config

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

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

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
double	compression()	Deprecated.
T	compression(double compression)	Deprecated.
static <T extends AbstractPercentilesAggregationBuilder<T>> org.elasticsearch.common.xcontent.ConstructingObjectParser<T,String>	createParser(String aggName, TriFunction<String,double[],PercentilesConfig,T> ctor, Supplier<PercentilesConfig> defaultConfig, org.elasticsearch.common.xcontent.ParseField valuesField)
protected org.elasticsearch.common.xcontent.XContentBuilder	doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
int	hashCode()
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
boolean	keyed()	Get whether the XContent response should be keyed
T	keyed(boolean keyed)	Set whether the XContent response should be keyed
PercentilesMethod	method()	Deprecated.
T	method(PercentilesMethod method)	Deprecated.
int	numberOfSignificantValueDigits()	Deprecated.
T	numberOfSignificantValueDigits(int numberOfSignificantValueDigits)	Deprecated.
PercentilesConfig	percentilesConfig()	Returns how the percentiles algorithm has been configured, or null if it has not been configured yet
T	percentilesConfig(PercentilesConfig percentilesConfig)	Sets how the percentiles algorithm should be configured

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

bucketCardinality, subAggregations

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

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

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

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

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

buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, shallowCopy, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.BaseAggregationBuilder

getType

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

isFragment

Field Details

KEYED_FIELD

public static final org.elasticsearch.common.xcontent.ParseField KEYED_FIELD

keyed

protected boolean keyed

values

protected double[] values

Method Details

createParser

public static <T extends AbstractPercentilesAggregationBuilder<T>>
org.elasticsearch.common.xcontent.ConstructingObjectParser<T,String> createParser(String aggName,
 TriFunction<String,double[],PercentilesConfig,T> ctor,
 Supplier<PercentilesConfig> defaultConfig,
 org.elasticsearch.common.xcontent.ParseField valuesField)

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

Throws:

IOException

keyed

public T keyed(boolean keyed)

Set whether the XContent response should be keyed

keyed

public boolean keyed()

Get whether the XContent response should be keyed

numberOfSignificantValueDigits

@Deprecated
public T numberOfSignificantValueDigits(int numberOfSignificantValueDigits)

Deprecated.

Expert: set the number of significant digits in the values. Only relevant when using PercentilesMethod.HDR. Deprecated: set numberOfSignificantValueDigits by configuring a PercentilesConfig.Hdr instead and set via percentilesConfig(PercentilesConfig)

numberOfSignificantValueDigits

@Deprecated
public int numberOfSignificantValueDigits()

Deprecated.

Expert: get the number of significant digits in the values. Only relevant when using PercentilesMethod.HDR. Deprecated: get numberOfSignificantValueDigits by inspecting the PercentilesConfig returned from percentilesConfig() instead

compression

@Deprecated
public T compression(double compression)

Deprecated.

Expert: set the compression. Higher values improve accuracy but also memory usage. Only relevant when using PercentilesMethod.TDIGEST. Deprecated: set compression by configuring a PercentilesConfig.TDigest instead and set via percentilesConfig(PercentilesConfig)

compression

@Deprecated
public double compression()

Deprecated.

Expert: get the compression. Higher values improve accuracy but also memory usage. Only relevant when using PercentilesMethod.TDIGEST. Deprecated: get compression by inspecting the PercentilesConfig returned from percentilesConfig() instead

method

@Deprecated
public T method(PercentilesMethod method)

Deprecated.

Deprecated: set method by configuring a PercentilesConfig instead and set via percentilesConfig(PercentilesConfig)

method

@Nullable
@Deprecated
public PercentilesMethod method()

Deprecated.

Deprecated: get method by inspecting the PercentilesConfig returned from percentilesConfig() instead

percentilesConfig

@Nullable
public PercentilesConfig percentilesConfig()

Returns how the percentiles algorithm has been configured, or null if it has not been configured yet

percentilesConfig

public T percentilesConfig(PercentilesConfig percentilesConfig)

Sets how the percentiles algorithm should be configured

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<T extends AbstractPercentilesAggregationBuilder<T>>

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<T extends AbstractPercentilesAggregationBuilder<T>>

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<T extends AbstractPercentilesAggregationBuilder<T>>