Package org.elasticsearch.xpack.esql.expression.function.aggregate

Class PercentileOverTime

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

org.elasticsearch.xpack.esql.expression.function.aggregate.TimeSeriesAggregateFunction

org.elasticsearch.xpack.esql.expression.function.aggregate.PercentileOverTime

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, Resolvable

public class PercentileOverTime
extends TimeSeriesAggregateFunction

Similar to Percentile, but it is used to calculate the percentile value over a time series of values from the given field.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

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

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

Field Summary

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

NO_WINDOW, WINDOW_INTERVAL

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
PercentileOverTime(Source source, Expression field, Expression percentile)
PercentileOverTime(Source source, Expression field, Expression filter, Expression window, Expression percentile)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()
String	getWriteableName()
protected NodeInfo<PercentileOverTime>	info()
AggregateFunction	perTimeSeriesAggregation()	Returns the aggregation function to be used in the first aggregation stage, which is grouped by `_tsid` (and `time_bucket`).
PercentileOverTime	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()
PercentileOverTime	withFilter(Expression filter)	Attach a filter to the aggregate function.

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.TimeSeriesAggregateFunction

aggregateInputReferences, requiredTimeSeriesSource

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

equals, field, filter, hasFilter, hashCode, hasWindow, parameters, postAnalysisPlanVerification, readWindow, window, withParameters, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, functionName, nodeString, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, fold, foldable, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

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

Constructor Details

PercentileOverTime

public PercentileOverTime(Source source,
 Expression field,
 Expression percentile)

PercentileOverTime

public PercentileOverTime(Source source,
 Expression field,
 Expression filter,
 Expression window,
 Expression percentile)

Method Details

resolveType

protected Expression.TypeResolution resolveType()

Overrides:

resolveType in class AggregateFunction

dataType

public DataType dataType()

Specified by:

dataType in class Expression

info

protected NodeInfo<PercentileOverTime> info()

Specified by:

info in class Node<Expression>

replaceChildren

public PercentileOverTime replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

withFilter

public PercentileOverTime withFilter(Expression filter)

Description copied from class: AggregateFunction

Attach a filter to the aggregate function.

Specified by:

withFilter in class AggregateFunction

perTimeSeriesAggregation

public AggregateFunction perTimeSeriesAggregation()

Description copied from class: TimeSeriesAggregateFunction

Returns the aggregation function to be used in the first aggregation stage, which is grouped by `_tsid` (and `time_bucket`).

Specified by:

perTimeSeriesAggregation in class TimeSeriesAggregateFunction

See Also:

• TranslateTimeSeriesAggregate

getWriteableName

public String getWriteableName()