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

Class FirstOverTime

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.FirstOverTime

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, Resolvable, OptionalArgument, TimestampAware, ToAggregator

public class FirstOverTime
extends TimeSeriesAggregateFunction
implements OptionalArgument, ToAggregator, TimestampAware

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

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY

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
FirstOverTime(StreamInput in)
FirstOverTime(Source source, Expression field, Expression window, Expression timestamp)
FirstOverTime(Source source, Expression field, Expression filter, Expression window, Expression timestamp)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()
String	getWriteableName()
protected NodeInfo<FirstOverTime>	info()
FirstOverTime	perTimeSeriesAggregation()	Returns the aggregation function to be used in the first aggregation stage, which is grouped by `_tsid` (and `time_bucket`).
FirstOverTime	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()
AggregatorFunctionSupplier	supplier()
Expression	timestamp()
String	toString()
FirstOverTime	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, typeResolved

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

anyMatch, children, collect, collect, 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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

FirstOverTime

public FirstOverTime(Source source,
 Expression field,
 Expression window,
 Expression timestamp)

FirstOverTime

public FirstOverTime(Source source,
 Expression field,
 Expression filter,
 Expression window,
 Expression timestamp)

FirstOverTime

public FirstOverTime(StreamInput in)
              throws IOException

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

info

protected NodeInfo<FirstOverTime> info()

Specified by:

info in class Node<Expression>

replaceChildren

public FirstOverTime replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

withFilter

public FirstOverTime withFilter(Expression filter)

Description copied from class: AggregateFunction

Attach a filter to the aggregate function.

Specified by:

withFilter in class AggregateFunction

dataType

public DataType dataType()

Specified by:

dataType in class Expression

resolveType

protected Expression.TypeResolution resolveType()

Overrides:

resolveType in class AggregateFunction

supplier

public AggregatorFunctionSupplier supplier()

Specified by:

supplier in interface ToAggregator

perTimeSeriesAggregation

public FirstOverTime 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

toString

public String toString()

Overrides:

toString in class Expression

timestamp

public Expression timestamp()

Specified by:

timestamp in interface TimestampAware