Record Class EsqlFunctionRegistry.FunctionDescription

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.expression.function.EsqlFunctionRegistry.FunctionDescription
Enclosing class:
EsqlFunctionRegistry

public static record EsqlFunctionRegistry.FunctionDescription(String name, List<EsqlFunctionRegistry.ArgSignature> args, String[] returnType, String description, boolean variadic, boolean isAggregation) extends Record
  • Constructor Details

    • FunctionDescription

      public FunctionDescription(String name, List<EsqlFunctionRegistry.ArgSignature> args, String[] returnType, String description, boolean variadic, boolean isAggregation)
      Creates an instance of a FunctionDescription record class.
      Parameters:
      name - the value for the name record component
      args - the value for the args record component
      returnType - the value for the returnType record component
      description - the value for the description record component
      variadic - the value for the variadic record component
      isAggregation - the value for the isAggregation record component
  • Method Details

    • argNames

      public List<String> argNames()
      The name of every argument.
    • argDescriptions

      public List<String> argDescriptions()
      The description of every argument.
    • 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
    • args

      Returns the value of the args record component.
      Returns:
      the value of the args record component
    • returnType

      public String[] returnType()
      Returns the value of the returnType record component.
      Returns:
      the value of the returnType record component
    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • variadic

      public boolean variadic()
      Returns the value of the variadic record component.
      Returns:
      the value of the variadic record component
    • isAggregation

      public boolean isAggregation()
      Returns the value of the isAggregation record component.
      Returns:
      the value of the isAggregation record component