Record Class EsQueryExec.FieldSort

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.plan.physical.EsQueryExec.FieldSort
All Implemented Interfaces:
EsQueryExec.Sort
Enclosing class:
EsQueryExec

public static record EsQueryExec.FieldSort(FieldAttribute field, Order.OrderDirection direction, Order.NullsPosition nulls) extends Record implements EsQueryExec.Sort
  • Constructor Details

    • FieldSort

      public FieldSort(FieldAttribute field, Order.OrderDirection direction, Order.NullsPosition nulls)
      Creates an instance of a FieldSort record class.
      Parameters:
      field - the value for the field record component
      direction - the value for the direction record component
      nulls - the value for the nulls record component
  • Method Details

    • sortBuilder

      public SortBuilder<?> sortBuilder()
      Specified by:
      sortBuilder in interface EsQueryExec.Sort
    • 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.
    • field

      public FieldAttribute field()
      Returns the value of the field record component.
      Specified by:
      field in interface EsQueryExec.Sort
      Returns:
      the value of the field record component
    • direction

      public Order.OrderDirection direction()
      Returns the value of the direction record component.
      Specified by:
      direction in interface EsQueryExec.Sort
      Returns:
      the value of the direction record component
    • nulls

      public Order.NullsPosition nulls()
      Returns the value of the nulls record component.
      Returns:
      the value of the nulls record component