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

Annotation Interface Param

@Retention(RUNTIME)
@Target({PARAMETER,FIELD})
public @interface Param

Describes function parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	Param.Hint

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name
String[]	type

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	description
Param.Hint	hint
boolean	optional
String	since

Element Details

name

String name

type

String[] type

description

String description

Default:

""

optional

boolean optional

Default:

false

since

String since

Default:

""

hint

@Nullable
Param.Hint hint

Default:

@org.elasticsearch.xpack.esql.expression.function.Param.Hint(entityType=NONE)