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

Class EsqlFunctionRegistry.ArgSignature

java.lang.Object

org.elasticsearch.xpack.esql.expression.function.EsqlFunctionRegistry.ArgSignature

Direct Known Subclasses:

EsqlFunctionRegistry.MapArgSignature

Enclosing class:

EsqlFunctionRegistry

public static class EsqlFunctionRegistry.ArgSignature
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EsqlFunctionRegistry.ArgSignature.Hint

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	description
protected final EsqlFunctionRegistry.ArgSignature.Hint	hint
protected final String	name
protected final boolean	optional
protected final DataType	targetDataType
protected final String[]	type
protected final boolean	variadic

Constructor Summary

Constructors

Constructor	Description
ArgSignature(String name, String[] type, String description, boolean optional, boolean variadic)
ArgSignature(String name, String[] type, String description, boolean optional, boolean variadic, DataType targetDataType)
ArgSignature(String name, String[] type, String description, boolean optional, boolean variadic, EsqlFunctionRegistry.ArgSignature.Hint hint, DataType targetDataType)
ArgSignature(String name, String[] type, String description, boolean optional, EsqlFunctionRegistry.ArgSignature.Hint hint, boolean variadic)

Method Summary

Modifier and Type	Method	Description
String	description()
boolean	mapArg()
Map<String,EsqlFunctionRegistry.MapEntryArgSignature>	mapParams()
String	name()
boolean	optional()
DataType	targetDataType()
String	toString()
String[]	type()
boolean	variadic()

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

type

protected final String[] type

description

protected final String description

optional

protected final boolean optional

variadic

protected final boolean variadic

targetDataType

protected final DataType targetDataType

hint

protected final EsqlFunctionRegistry.ArgSignature.Hint hint

Constructor Details

ArgSignature

public ArgSignature(String name,
 String[] type,
 String description,
 boolean optional,
 boolean variadic,
 EsqlFunctionRegistry.ArgSignature.Hint hint,
 DataType targetDataType)

ArgSignature

public ArgSignature(String name,
 String[] type,
 String description,
 boolean optional,
 EsqlFunctionRegistry.ArgSignature.Hint hint,
 boolean variadic)

ArgSignature

public ArgSignature(String name,
 String[] type,
 String description,
 boolean optional,
 boolean variadic,
 DataType targetDataType)

ArgSignature

public ArgSignature(String name,
 String[] type,
 String description,
 boolean optional,
 boolean variadic)

Method Details

name

public String name()

type

public String[] type()

description

public String description()

optional

public boolean optional()

variadic

public boolean variadic()

targetDataType

public DataType targetDataType()

mapParams

public Map<String,EsqlFunctionRegistry.MapEntryArgSignature> mapParams()

mapArg

public boolean mapArg()

toString

public String toString()

Overrides:

toString in class Object