Package org.elasticsearch.xpack.esql.plan

Record Class QuerySettings.QuerySettingDef<T>

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.plan.QuerySettings.QuerySettingDef<T>
Type Parameters:
T - The type of the setting value.
Record Components:
name - The name to be used when setting it in the query. E.g. SET name=value
type - The allowed datatype of the setting.
serverlessOnly -
preview -
snapshotOnly -
description - The user-facing description of the setting.
validator - A validation function to check the setting value. Defaults to calling the parser and returning the error message of any exception it throws.
parser - A function to parse the setting value into the final object.
defaultValueSupplier - A supplier of the default value to be used when the setting is not set.
Enclosing class:
QuerySettings
public static record QuerySettings.QuerySettingDef<T>(String name, DataType type, boolean serverlessOnly, boolean preview, boolean snapshotOnly, String description, QuerySettings.QuerySettingDef.Validator validator, QuerySettings.QuerySettingDef.Parser<T> parser, Function<RemoteClusterService,T> defaultValueSupplier) extends Record
Definition of a query setting.

  • Constructor Details

  • Method Details

    • get

      public T get(Expression value, RemoteClusterService clusterService)

    • 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 DataType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • serverlessOnly

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

    • preview

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

    • snapshotOnly

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

    • description

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

    • validator

      public QuerySettings.QuerySettingDef.Validator validator()
      Returns the value of the validator record component.
      Returns:
      the value of the validator record component

    • parser

      public QuerySettings.QuerySettingDef.Parser<T> parser()
      Returns the value of the parser record component.
      Returns:
      the value of the parser record component

    • defaultValueSupplier

      public Function<RemoteClusterService,T> defaultValueSupplier()
      Returns the value of the defaultValueSupplier record component.
      Returns:
      the value of the defaultValueSupplier record component