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

Class FunctionDefinition.Builder<T extends Function>

java.lang.Object

org.elasticsearch.xpack.esql.expression.function.FunctionDefinition.Builder<T>

Enclosing class:

FunctionDefinition

public static class FunctionDefinition.Builder<T extends Function>
extends Object

A builder for FunctionDefinitions. Get one from FunctionDefinition.def(java.lang.Class<T>).

Method Summary

Modifier and Type	Method	Description
FunctionDefinition.Builder<T>	binary(FunctionDefinition.BinaryBuilder<T> ctorRef)	Build a FunctionDefinition for a binary function.
FunctionDefinition.Builder<T>	binaryConfig(FunctionDefinition.BinaryConfigurationAwareBuilder<T> ctorRef)	Build a FunctionDefinition for a binary function that needs Configuration.
FunctionDefinition.Builder<T>	capabilities(String... capabilities)	Adds capabilities to mark changes or fixes to the function.
FunctionDefinition	name(String name, String... aliases)	Build the FunctionDefinition with the given primary name and optional aliases.
FunctionDefinition.Builder<T>	nAry(FunctionDefinition.NaryBuilder<T> ctorRef)	Build a FunctionDefinition for a function with any number of arguments.
FunctionDefinition.Builder<T>	noArgs(Function<Source,T> ctorRef)	Build a FunctionDefinition for a no-argument function.
FunctionDefinition.Builder<T>	noArgs(FunctionDefinition.ConfigurationAwareBuilder<T> ctorRef)	Build a FunctionDefinition for a no-argument function that needs Configuration.
FunctionDefinition.Builder<T>	quaternary(FunctionDefinition.QuaternaryBuilder<T> ctorRef)	Build a FunctionDefinition for a quaternary function.
FunctionDefinition.Builder<T>	quaternaryConfig(FunctionDefinition.QuaternaryConfigurationAwareBuilder<T> ctorRef)	Build a FunctionDefinition for a quaternary function that needs Configuration.
FunctionDefinition.Builder<T>	quinary(FunctionDefinition.QuinaryBuilder<T> ctorRef, int numOptionalParams)	Build a FunctionDefinition for a quinary function.
FunctionDefinition.Builder<T>	ternary(FunctionDefinition.TernaryBuilder<T> ctorRef)	Build a FunctionDefinition for a ternary function.
FunctionDefinition.Builder<T>	ternaryConfig(FunctionDefinition.TernaryConfigurationAwareBuilder<T> ctorRef)	Build a FunctionDefinition for a ternary function that needs Configuration.
FunctionDefinition.Builder<T>	unary(BiFunction<Source,Expression,T> ctorRef)	Build a FunctionDefinition for a unary function.
FunctionDefinition.Builder<T>	unaryConfig(FunctionDefinition.UnaryConfigurationAwareBuilder<T> ctorRef)	Build a FunctionDefinition for a unary function that needs Configuration.
FunctionDefinition.Builder<T>	unaryVariadic(FunctionDefinition.UnaryVariadicBuilder<T> ctorRef)	Build a FunctionDefinition for a function with one required argument followed by zero or more variadic arguments.

Methods inherited from class java.lang.Object

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

Method Details

capabilities

public FunctionDefinition.Builder<T> capabilities(String... capabilities)

Adds capabilities to mark changes or fixes to the function. Use it like:

public static final FunctionDefinition DEFINITION = FunctionDefinition.def(IpPrefix.class)
    .ternary(IpPrefix::new)
    // Fix a bug leading to the scratch leaking data to other rows.
    .capabilities("fix_dirty_scratch_leak")
    .name("ip_prefix");

name

public FunctionDefinition name(String name,
 String... aliases)

Build the FunctionDefinition with the given primary name and optional aliases.

noArgs

public FunctionDefinition.Builder<T> noArgs(Function<Source,T> ctorRef)

Build a FunctionDefinition for a no-argument function.

noArgs

public FunctionDefinition.Builder<T> noArgs(FunctionDefinition.ConfigurationAwareBuilder<T> ctorRef)

Build a FunctionDefinition for a no-argument function that needs Configuration.

unary

public FunctionDefinition.Builder<T> unary(BiFunction<Source,Expression,T> ctorRef)

Build a FunctionDefinition for a unary function.

unaryConfig

public FunctionDefinition.Builder<T> unaryConfig(FunctionDefinition.UnaryConfigurationAwareBuilder<T> ctorRef)

Build a FunctionDefinition for a unary function that needs Configuration.

unaryVariadic

public FunctionDefinition.Builder<T> unaryVariadic(FunctionDefinition.UnaryVariadicBuilder<T> ctorRef)

Build a FunctionDefinition for a function with one required argument followed by zero or more variadic arguments.

binary

public FunctionDefinition.Builder<T> binary(FunctionDefinition.BinaryBuilder<T> ctorRef)

Build a FunctionDefinition for a binary function.

binaryConfig

public FunctionDefinition.Builder<T> binaryConfig(FunctionDefinition.BinaryConfigurationAwareBuilder<T> ctorRef)

Build a FunctionDefinition for a binary function that needs Configuration.

ternary

public FunctionDefinition.Builder<T> ternary(FunctionDefinition.TernaryBuilder<T> ctorRef)

Build a FunctionDefinition for a ternary function.

ternaryConfig

public FunctionDefinition.Builder<T> ternaryConfig(FunctionDefinition.TernaryConfigurationAwareBuilder<T> ctorRef)

Build a FunctionDefinition for a ternary function that needs Configuration.

quaternary

public FunctionDefinition.Builder<T> quaternary(FunctionDefinition.QuaternaryBuilder<T> ctorRef)

Build a FunctionDefinition for a quaternary function.

quaternaryConfig

public FunctionDefinition.Builder<T> quaternaryConfig(FunctionDefinition.QuaternaryConfigurationAwareBuilder<T> ctorRef)

Build a FunctionDefinition for a quaternary function that needs Configuration.

quinary

public FunctionDefinition.Builder<T> quinary(FunctionDefinition.QuinaryBuilder<T> ctorRef,
 int numOptionalParams)

Build a FunctionDefinition for a quinary function.

nAry

public FunctionDefinition.Builder<T> nAry(FunctionDefinition.NaryBuilder<T> ctorRef)

Build a FunctionDefinition for a function with any number of arguments.