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

Class PromqlFunctionDefinition.Builder

java.lang.Object

org.elasticsearch.xpack.esql.expression.promql.function.PromqlFunctionDefinition.Builder

Enclosing class:

PromqlFunctionDefinition

public static class PromqlFunctionDefinition.Builder
extends Object

A builder for PromqlFunctionDefinitions. Get one from PromqlFunctionDefinition.def().

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PromqlFunctionDefinition.Builder	acrossSeries(BiFunction<Source,Expression,? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	acrossSeriesBinary(PromqlFunctionDefinition.PromqlParamInfo paramInfo, FunctionDefinition.QuaternaryBuilder<? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	binaryOptionalValueTransformation(PromqlFunctionDefinition.PromqlParamInfo p, PromqlFunctionDefinition.PromqlBinaryOptionalValueTransformation ctorRef)
PromqlFunctionDefinition.Builder	binaryValueTransformation(PromqlFunctionDefinition.PromqlParamInfo p, FunctionDefinition.BinaryBuilder<? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	counterSupport(PromqlFunctionDefinition.CounterSupport counterSupport)
PromqlFunctionDefinition.Builder	dateTime(PromqlFunctionDefinition.DateTimeFunctionBuilder ctorRef)	Builds a date/time extraction function that accepts an optional instant vector argument.
PromqlFunctionDefinition.Builder	description(String description)
PromqlFunctionDefinition.Builder	differenceFromPrometheus(String differenceFromPrometheus)	Documents how this function's Elasticsearch behavior diverges from the Prometheus reference.
PromqlFunctionDefinition.Builder	example(String example)
PromqlFunctionDefinition.Builder	extendedDescription(String extendedDescription)	Adds a description paragraph rendered only on the function's own reference page, after the brief summary.
PromqlFunctionDefinition.Builder	histogramBinary(PromqlFunctionDefinition.PromqlParamInfo paramInfo, PromqlFunctionDefinition.FunctionBuilder builder)
PromqlFunctionDefinition.Builder	histogramUnary(BiFunction<Source,Expression,? extends Expression> ctorRef)
PromqlFunctionDefinition	name(String name)	Build the PromqlFunctionDefinition with the given primary name.
PromqlFunctionDefinition.Builder	scalar(Function<Source,? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	scalarConversion(BiFunction<Source,Expression,? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	scalarWithStep(BiFunction<Source,Expression,? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	stack(List<PromqlFunctionDefinition.StackAvailability> stack)	Declares the stack availability rendered into the function's docs applies_to badge.
PromqlFunctionDefinition.Builder	ternaryValueTransformation(PromqlFunctionDefinition.PromqlParamInfo p1, PromqlFunctionDefinition.PromqlParamInfo p2, FunctionDefinition.TernaryBuilder<? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	unaryValueTransformation(BiFunction<Source,Expression,? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	withinSeries(FunctionDefinition.TernaryBuilder<? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	withinSeries(PromqlFunctionDefinition.PromqlParamInfo paramInfo, FunctionDefinition.QuaternaryBuilder<? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	withinSeriesOverTime(FunctionDefinition.TernaryBuilder<? extends Expression> ctorRef)
PromqlFunctionDefinition.Builder	withinSeriesOverTimeBinary(PromqlFunctionDefinition.PromqlParamInfo paramInfo, FunctionDefinition.QuaternaryBuilder<? extends Expression> ctorRef)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

counterSupport

public PromqlFunctionDefinition.Builder counterSupport(PromqlFunctionDefinition.CounterSupport counterSupport)

description

public PromqlFunctionDefinition.Builder description(String description)

extendedDescription

public PromqlFunctionDefinition.Builder extendedDescription(String extendedDescription)

Adds a description paragraph rendered only on the function's own reference page, after the brief summary. Use this for behavior detail that should not bloat the short summaries shown in the functions overview. Omit for functions whose full description fits in description.

differenceFromPrometheus

public PromqlFunctionDefinition.Builder differenceFromPrometheus(String differenceFromPrometheus)

Documents how this function's Elasticsearch behavior diverges from the Prometheus reference. Rendered as a "Differences from Prometheus" section in the generated docs. Omit for functions that match Prometheus.

stack

public PromqlFunctionDefinition.Builder stack(List<PromqlFunctionDefinition.StackAvailability> stack)

Declares the stack availability rendered into the function's docs applies_to badge. Use the PromqlFunctionDefinition.STACK_PREVIEW_9_4_GA_9_5 / PromqlFunctionDefinition.STACK_GA_9_5 presets for the common cases. Serverless availability is intentionally not declared here: implemented PromQL functions are generally available in serverless, which is stated once at the docs page level rather than repeated per function. (When a function first ships as a serverless preview, add a serverless entry here.)

example

public PromqlFunctionDefinition.Builder example(String example)

unaryValueTransformation

public PromqlFunctionDefinition.Builder unaryValueTransformation(BiFunction<Source,Expression,? extends Expression> ctorRef)

binaryValueTransformation

public PromqlFunctionDefinition.Builder binaryValueTransformation(PromqlFunctionDefinition.PromqlParamInfo p,
 FunctionDefinition.BinaryBuilder<? extends Expression> ctorRef)

binaryOptionalValueTransformation

public PromqlFunctionDefinition.Builder binaryOptionalValueTransformation(PromqlFunctionDefinition.PromqlParamInfo p,
 PromqlFunctionDefinition.PromqlBinaryOptionalValueTransformation ctorRef)

ternaryValueTransformation

public PromqlFunctionDefinition.Builder ternaryValueTransformation(PromqlFunctionDefinition.PromqlParamInfo p1,
 PromqlFunctionDefinition.PromqlParamInfo p2,
 FunctionDefinition.TernaryBuilder<? extends Expression> ctorRef)

withinSeries

public PromqlFunctionDefinition.Builder withinSeries(FunctionDefinition.TernaryBuilder<? extends Expression> ctorRef)

withinSeries

public PromqlFunctionDefinition.Builder withinSeries(PromqlFunctionDefinition.PromqlParamInfo paramInfo,
 FunctionDefinition.QuaternaryBuilder<? extends Expression> ctorRef)

withinSeriesOverTime

public PromqlFunctionDefinition.Builder withinSeriesOverTime(FunctionDefinition.TernaryBuilder<? extends Expression> ctorRef)

withinSeriesOverTimeBinary

public PromqlFunctionDefinition.Builder withinSeriesOverTimeBinary(PromqlFunctionDefinition.PromqlParamInfo paramInfo,
 FunctionDefinition.QuaternaryBuilder<? extends Expression> ctorRef)

acrossSeries

public PromqlFunctionDefinition.Builder acrossSeries(BiFunction<Source,Expression,? extends Expression> ctorRef)

acrossSeriesBinary

public PromqlFunctionDefinition.Builder acrossSeriesBinary(PromqlFunctionDefinition.PromqlParamInfo paramInfo,
 FunctionDefinition.QuaternaryBuilder<? extends Expression> ctorRef)

histogramUnary

public PromqlFunctionDefinition.Builder histogramUnary(BiFunction<Source,Expression,? extends Expression> ctorRef)

histogramBinary

public PromqlFunctionDefinition.Builder histogramBinary(PromqlFunctionDefinition.PromqlParamInfo paramInfo,
 PromqlFunctionDefinition.FunctionBuilder builder)

scalar

public PromqlFunctionDefinition.Builder scalar(Function<Source,? extends Expression> ctorRef)

scalarWithStep

public PromqlFunctionDefinition.Builder scalarWithStep(BiFunction<Source,Expression,? extends Expression> ctorRef)

dateTime

public PromqlFunctionDefinition.Builder dateTime(PromqlFunctionDefinition.DateTimeFunctionBuilder ctorRef)

Builds a date/time extraction function that accepts an optional instant vector argument. When no argument is provided, the evaluation step timestamp (or fallback timestamp) is used. When the argument is a numeric value (seconds since epoch), it is converted to a datetime first.

scalarConversion

public PromqlFunctionDefinition.Builder scalarConversion(BiFunction<Source,Expression,? extends Expression> ctorRef)

name

public PromqlFunctionDefinition name(String name)

Build the PromqlFunctionDefinition with the given primary name.