Class PercentileRanksAggregationBuilder
- 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.Numeric,PercentileRanksAggregationBuilder>
-
- org.elasticsearch.search.aggregations.metrics.PercentileRanksAggregationBuilder
-
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,BaseAggregationBuilder
public class PercentileRanksAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly<ValuesSource.Numeric,PercentileRanksAggregationBuilder>
-
-
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 java.lang.String
NAME
static ParseField
VALUES_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
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Modifier Constructor Description PercentileRanksAggregationBuilder(java.lang.String name, double[] values)
PercentileRanksAggregationBuilder(StreamInput in)
Read from a stream.protected
PercentileRanksAggregationBuilder(PercentileRanksAggregationBuilder 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.PercentileRanksAggregationBuilder
compression(double compression)
Expert: set the compression.protected XContentBuilder
doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.lang.String
getType()
The name of the type of aggregation built by this builder.protected ValuesSourceAggregatorFactory<ValuesSource.Numeric,?>
innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource.Numeric> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean
innerEquals(java.lang.Object obj)
protected int
innerHashCode()
protected void
innerWriteTo(StreamOutput out)
Write subclass's state to the stream.boolean
keyed()
Get whether the XContent response should be keyedPercentileRanksAggregationBuilder
keyed(boolean keyed)
Set whether the XContent response should be keyedPercentilesMethod
method()
PercentileRanksAggregationBuilder
method(PercentilesMethod method)
int
numberOfSignificantValueDigits()
Expert: get the number of significant digits in the values.PercentileRanksAggregationBuilder
numberOfSignificantValueDigits(int numberOfSignificantValueDigits)
Expert: set the number of significant digits in the values.static AggregationBuilder
parse(java.lang.String aggregationName, XContentParser parser)
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
.double[]
values()
Get the values to compute percentiles from.-
Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly
subAggregations
-
Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
doBuild, doEquals, doHashCode, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, valueType, valueType
-
Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, toXContent, writeTo
-
Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
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.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Field Detail
-
NAME
public static final java.lang.String NAME
- See Also:
- Constant Field Values
-
VALUES_FIELD
public static final ParseField VALUES_FIELD
-
-
Constructor Detail
-
PercentileRanksAggregationBuilder
public PercentileRanksAggregationBuilder(java.lang.String name, double[] values)
-
PercentileRanksAggregationBuilder
protected PercentileRanksAggregationBuilder(PercentileRanksAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
-
PercentileRanksAggregationBuilder
public PercentileRanksAggregationBuilder(StreamInput in) throws java.io.IOException
Read from a stream.- Throws:
java.io.IOException
-
-
Method Detail
-
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
protected void innerWriteTo(StreamOutput out) throws java.io.IOException
Description copied from class:ValuesSourceAggregationBuilder
Write subclass's state to the stream.- Specified by:
innerWriteTo
in classValuesSourceAggregationBuilder<ValuesSource.Numeric,PercentileRanksAggregationBuilder>
- Throws:
java.io.IOException
-
values
public double[] values()
Get the values to compute percentiles from.
-
keyed
public PercentileRanksAggregationBuilder keyed(boolean keyed)
Set whether the XContent response should be keyed
-
keyed
public boolean keyed()
Get whether the XContent response should be keyed
-
numberOfSignificantValueDigits
public PercentileRanksAggregationBuilder 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
public PercentileRanksAggregationBuilder compression(double 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
public PercentileRanksAggregationBuilder method(PercentilesMethod method)
-
method
public PercentilesMethod method()
-
innerBuild
protected ValuesSourceAggregatorFactory<ValuesSource.Numeric,?> innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource.Numeric> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException
- Specified by:
innerBuild
in classValuesSourceAggregationBuilder<ValuesSource.Numeric,PercentileRanksAggregationBuilder>
- Throws:
java.io.IOException
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
doXContentBody
in classValuesSourceAggregationBuilder<ValuesSource.Numeric,PercentileRanksAggregationBuilder>
- Throws:
java.io.IOException
-
innerEquals
protected boolean innerEquals(java.lang.Object obj)
- Specified by:
innerEquals
in classValuesSourceAggregationBuilder<ValuesSource.Numeric,PercentileRanksAggregationBuilder>
-
innerHashCode
protected int innerHashCode()
- Specified by:
innerHashCode
in classValuesSourceAggregationBuilder<ValuesSource.Numeric,PercentileRanksAggregationBuilder>
-
getType
public java.lang.String getType()
Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder.
-
-