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

Record Class PromqlFunctionRegistry.FunctionDefinition

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.esql.expression.promql.function.PromqlFunctionRegistry.FunctionDefinition

Enclosing class:

PromqlFunctionRegistry

public static record PromqlFunctionRegistry.FunctionDefinition(String name, FunctionType functionType, PromqlFunctionRegistry.Arity arity, PromqlFunctionRegistry.EsqlFunctionBuilder esqlBuilder, String description, List<PromqlFunctionRegistry.ParamInfo> params, List<String> examples, PromqlFunctionRegistry.CounterSupport counterSupport)
extends Record

Function definition record for registration and metadata.

Constructor Summary

Constructors

Constructor	Description
FunctionDefinition(String name, FunctionType functionType, PromqlFunctionRegistry.Arity arity, PromqlFunctionRegistry.EsqlFunctionBuilder esqlBuilder, String description, List<PromqlFunctionRegistry.ParamInfo> params, List<String> examples, PromqlFunctionRegistry.CounterSupport counterSupport)	Creates an instance of a FunctionDefinition record class.

Method Summary

Modifier and Type	Method	Description
PromqlFunctionRegistry.Arity	arity()	Returns the value of the arity record component.
PromqlFunctionRegistry.CounterSupport	counterSupport()	Returns the value of the counterSupport record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
PromqlFunctionRegistry.EsqlFunctionBuilder	esqlBuilder()	Returns the value of the esqlBuilder record component.
List<String>	examples()	Returns the value of the examples record component.
FunctionType	functionType()	Returns the value of the functionType record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
List<PromqlFunctionRegistry.ParamInfo>	params()	Returns the value of the params record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FunctionDefinition

public FunctionDefinition(String name,
 FunctionType functionType,
 PromqlFunctionRegistry.Arity arity,
 PromqlFunctionRegistry.EsqlFunctionBuilder esqlBuilder,
 String description,
 List<PromqlFunctionRegistry.ParamInfo> params,
 List<String> examples,
 PromqlFunctionRegistry.CounterSupport counterSupport)

Creates an instance of a FunctionDefinition record class.

Parameters:

name - the value for the name record component

functionType - the value for the functionType record component

arity - the value for the arity record component

esqlBuilder - the value for the esqlBuilder record component

description - the value for the description record component

params - the value for the params record component

examples - the value for the examples record component

counterSupport - the value for the counterSupport record component

Method Details

toString

public final String 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.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

functionType

public FunctionType functionType()

Returns the value of the functionType record component.

Returns:

the value of the functionType record component

arity

public PromqlFunctionRegistry.Arity arity()

Returns the value of the arity record component.

Returns:

the value of the arity record component

esqlBuilder

public PromqlFunctionRegistry.EsqlFunctionBuilder esqlBuilder()

Returns the value of the esqlBuilder record component.

Returns:

the value of the esqlBuilder record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

params

public List<PromqlFunctionRegistry.ParamInfo> params()

Returns the value of the params record component.

Returns:

the value of the params record component

examples

public List<String> examples()

Returns the value of the examples record component.

Returns:

the value of the examples record component

counterSupport

public PromqlFunctionRegistry.CounterSupport counterSupport()

Returns the value of the counterSupport record component.

Returns:

the value of the counterSupport record component