Class PercentilesAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<VS,AB>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly<ValuesSource,PercentilesAggregationBuilder>
org.elasticsearch.search.aggregations.metrics.PercentilesAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,BaseAggregationBuilder
public class PercentilesAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly<ValuesSource,PercentilesAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.CommonFields
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 static ParseField
COMPRESSION_FIELD
static ParseField
KEYED_FIELD
static java.lang.String
NAME
static ParseField
NUMBER_SIGNIFICANT_DIGITS_FIELD
static ParseField
PERCENTS_FIELD
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
factoriesBuilder, name
-
Constructor Summary
Constructors Modifier Constructor Description PercentilesAggregationBuilder(java.lang.String name)
PercentilesAggregationBuilder(StreamInput in)
Read from a stream.protected
PercentilesAggregationBuilder(PercentilesAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
-
Method Summary
Modifier and Type Method Description double
compression()
Expert: get the compression.PercentilesAggregationBuilder
compression(double compression)
Expert: set the compression.protected XContentBuilder
doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean
equals(java.lang.Object obj)
java.lang.String
getType()
The name of the type of aggregation built by this builder.int
hashCode()
protected ValuesSourceAggregatorFactory<ValuesSource>
innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<ValuesSource> config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void
innerWriteTo(StreamOutput out)
Write subclass's state to the stream.boolean
keyed()
Get whether the XContent response should be keyedPercentilesAggregationBuilder
keyed(boolean keyed)
Set whether the XContent response should be keyedPercentilesMethod
method()
PercentilesAggregationBuilder
method(PercentilesMethod method)
int
numberOfSignificantValueDigits()
Expert: get the number of significant digits in the values.PercentilesAggregationBuilder
numberOfSignificantValueDigits(int numberOfSignificantValueDigits)
Expert: set the number of significant digits in the values.static AggregationBuilder
parse(java.lang.String aggregationName, XContentParser parser)
double[]
percentiles()
Get the values to compute percentiles from.PercentilesAggregationBuilder
percentiles(double... percents)
Set the values to compute percentiles from.protected AggregationBuilder
shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetaData
.Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly
subAggregations
Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
defaultValueType, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, resolveScriptAny, script, script, serializeTargetValueType, timeZone, timeZone, valueType, valueType
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, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
PERCENTS_FIELD
-
KEYED_FIELD
-
COMPRESSION_FIELD
-
NUMBER_SIGNIFICANT_DIGITS_FIELD
-
-
Constructor Details
-
PercentilesAggregationBuilder
public PercentilesAggregationBuilder(java.lang.String name) -
PercentilesAggregationBuilder
protected PercentilesAggregationBuilder(PercentilesAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData) -
PercentilesAggregationBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
parse
public static AggregationBuilder parse(java.lang.String aggregationName, XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)Description copied from class:AggregationBuilder
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetaData
. Used byAggregationBuilder.rewrite(QueryRewriteContext)
.- Specified by:
shallowCopy
in classAggregationBuilder
-
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilder
Write subclass's state to the stream.- Specified by:
innerWriteTo
in classValuesSourceAggregationBuilder<ValuesSource,PercentilesAggregationBuilder>
- Throws:
java.io.IOException
-
percentiles
Set the values to compute percentiles from. -
percentiles
public double[] percentiles()Get the values to compute percentiles from. -
keyed
Set whether the XContent response should be keyed -
keyed
public boolean keyed()Get whether the XContent response should be keyed -
numberOfSignificantValueDigits
public PercentilesAggregationBuilder numberOfSignificantValueDigits(int numberOfSignificantValueDigits)Expert: set the number of significant digits in the values. Only relevant when usingPercentilesMethod.HDR
. -
numberOfSignificantValueDigits
public int numberOfSignificantValueDigits()Expert: get the number of significant digits in the values. Only relevant when usingPercentilesMethod.HDR
. -
compression
Expert: set the compression. Higher values improve accuracy but also memory usage. Only relevant when usingPercentilesMethod.TDIGEST
. -
compression
public double compression()Expert: get the compression. Higher values improve accuracy but also memory usage. Only relevant when usingPercentilesMethod.TDIGEST
. -
method
-
method
-
innerBuild
protected ValuesSourceAggregatorFactory<ValuesSource> innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<ValuesSource> config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException- Specified by:
innerBuild
in classValuesSourceAggregationBuilder<ValuesSource,PercentilesAggregationBuilder>
- Throws:
java.io.IOException
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContentBody
in classValuesSourceAggregationBuilder<ValuesSource,PercentilesAggregationBuilder>
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classValuesSourceAggregationBuilder<ValuesSource,PercentilesAggregationBuilder>
-
hashCode
public int hashCode()- Overrides:
hashCode
in classValuesSourceAggregationBuilder<ValuesSource,PercentilesAggregationBuilder>
-
getType
public java.lang.String getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder.
-