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

Interface TemporalityAware

All Known Implementing Classes:
DeltaOnlyHistogramMergeOverTime, HistogramMergeOverTime, Increase, Irate, LegacyIrate, Rate
public interface TemporalityAware
Marker interface for TimeSeriesAggregateFunctions to identify classes of functions that operate on the temporality field of an index. Implementations of this interface need to expect the temporality Attribute to be passed after all regular arguments. Implementations that also need the {code @timestamp} should additionally implement TimestampAware.

  • Method Details

    • temporality

      @Nullable Expression temporality()
      The current value for the temporality argument of the function. If this is null, it will be injected automatically during local planning.
      Returns:
      the current value for the temporality argument

    • withTemporality

      TimeSeriesAggregateFunction withTemporality(Expression temporality)
      Returns a copy of this function with the provided value as temporality argument.