Package org.elasticsearch.search.fetch.subphase

Record Class LookupField

java.lang.Object
java.lang.Record
org.elasticsearch.search.fetch.subphase.LookupField
All Implemented Interfaces:
Writeable
public record LookupField(String targetIndex, QueryBuilder query, List<FieldAndFormat> fetchFields, int size) extends Record implements Writeable
A LookupField is an **unresolved** fetch field whose values will be resolved later in the fetch phase on the coordinating node.
See Also:

  • Constructor Details

    • LookupField

      public LookupField(StreamInput in) throws IOException
      Throws:
      IOException

    • LookupField

      public LookupField(String targetIndex, QueryBuilder query, List<FieldAndFormat> fetchFields, int size)
      Creates an instance of a LookupField record class.
      Parameters:
      targetIndex - the value for the targetIndex record component
      query - the value for the query record component
      fetchFields - the value for the fetchFields record component
      size - the value for the size record component

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toSearchRequest

      public SearchRequest toSearchRequest(String clusterAlias)

    • 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.

    • targetIndex

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

    • query

      public QueryBuilder query()
      Returns the value of the query record component.
      Returns:
      the value of the query record component

    • fetchFields

      public List<FieldAndFormat> fetchFields()
      Returns the value of the fetchFields record component.
      Returns:
      the value of the fetchFields record component

    • size

      public int size()
      Returns the value of the size record component.
      Returns:
      the value of the size record component