Record Class EsqlFunctionRegistry.FunctionDescription
java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.expression.function.EsqlFunctionRegistry.FunctionDescription
- Enclosing class:
EsqlFunctionRegistry
-
Constructor Summary
ConstructorsConstructorDescriptionFunctionDescription(String name, List<EsqlFunctionRegistry.ArgSignature> args, String[] returnType, String description, boolean variadic, boolean isAggregation) Creates an instance of aFunctionDescriptionrecord class. -
Method Summary
Modifier and TypeMethodDescriptionThe description of every argument.argNames()The name of every argument.args()Returns the value of theargsrecord component.Returns the value of thedescriptionrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.booleanReturns the value of theisAggregationrecord component.name()Returns the value of thenamerecord component.String[]Returns the value of thereturnTyperecord component.final StringtoString()Returns a string representation of this record class.booleanvariadic()Returns the value of thevariadicrecord component.
-
Constructor Details
-
FunctionDescription
public FunctionDescription(String name, List<EsqlFunctionRegistry.ArgSignature> args, String[] returnType, String description, boolean variadic, boolean isAggregation) Creates an instance of aFunctionDescriptionrecord class.- Parameters:
name- the value for thenamerecord componentargs- the value for theargsrecord componentreturnType- the value for thereturnTyperecord componentdescription- the value for thedescriptionrecord componentvariadic- the value for thevariadicrecord componentisAggregation- the value for theisAggregationrecord component
-
-
Method Details
-
argNames
The name of every argument. -
argDescriptions
The description of every argument. -
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with '=='. -
name
Returns the value of thenamerecord component.- Returns:
- the value of the
namerecord component
-
args
Returns the value of theargsrecord component.- Returns:
- the value of the
argsrecord component
-
returnType
Returns the value of thereturnTyperecord component.- Returns:
- the value of the
returnTyperecord component
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
variadic
public boolean variadic()Returns the value of thevariadicrecord component.- Returns:
- the value of the
variadicrecord component
-
isAggregation
public boolean isAggregation()Returns the value of theisAggregationrecord component.- Returns:
- the value of the
isAggregationrecord component
-