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

Record Class PromqlFunctionRegistry.ParamInfo

java.lang.Object

java.lang.Record

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

Enclosing class:

PromqlFunctionRegistry

public static record PromqlFunctionRegistry.ParamInfo(String name, PromqlDataType type, String description, boolean optional, boolean child)
extends Record

Constructor Summary

Constructors

Constructor	Description
ParamInfo(String name, PromqlDataType type, String description, boolean optional, boolean child)	Creates an instance of a ParamInfo record class.

Method Summary

Modifier and Type	Method	Description
boolean	child()	Returns the value of the child record component.
static PromqlFunctionRegistry.ParamInfo	child(String name, PromqlDataType type, String description)
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.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
static PromqlFunctionRegistry.ParamInfo	of(String name, PromqlDataType type, String description)
boolean	optional()	Returns the value of the optional record component.
static PromqlFunctionRegistry.ParamInfo	optional(String name, PromqlDataType type, String description)
final String	toString()	Returns a string representation of this record class.
PromqlDataType	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ParamInfo

public ParamInfo(String name,
 PromqlDataType type,
 String description,
 boolean optional,
 boolean child)

Creates an instance of a ParamInfo record class.

Parameters:

name - the value for the name record component

type - the value for the type record component

description - the value for the description record component

optional - the value for the optional record component

child - the value for the child record component

Method Details

child

public static PromqlFunctionRegistry.ParamInfo child(String name,
 PromqlDataType type,
 String description)

of

public static PromqlFunctionRegistry.ParamInfo of(String name,
 PromqlDataType type,
 String description)

optional

public static PromqlFunctionRegistry.ParamInfo optional(String name,
 PromqlDataType type,
 String description)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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

type

public PromqlDataType type()

Returns the value of the type record component.

Returns:

the value of the type record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

optional

public boolean optional()

Returns the value of the optional record component.

Returns:

the value of the optional record component

child

public boolean child()

Returns the value of the child record component.

Returns:

the value of the child record component