Module org.elasticsearch.server

Package org.elasticsearch.search.query

Record Class QueryPhaseResult

java.lang.Object

java.lang.Record

org.elasticsearch.search.query.QueryPhaseResult

Record Components:

topDocsAndMaxScore - the TopDocs as wel as the optional maximum score

sortValueFormats - the fields that the request was sorted on

terminatedAfter - whether the request was early terminated, based on the terminate_after functionality

collectorResult - the profile result (when profiling was enabled)

public record QueryPhaseResult(TopDocsAndMaxScore topDocsAndMaxScore, DocValueFormat[] sortValueFormats, boolean terminatedAfter, CollectorResult collectorResult)
extends Record

Includes result returned by a search operation as part of the query phase.

Constructor Summary

Constructors

Constructor	Description
QueryPhaseResult(TopDocsAndMaxScore topDocsAndMaxScore, DocValueFormat[] sortValueFormats, boolean terminatedAfter, CollectorResult collectorResult)	Creates an instance of a QueryPhaseResult record class.

Method Summary

Modifier and Type	Method	Description
CollectorResult	collectorResult()	Returns the value of the collectorResult 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.
DocValueFormat[]	sortValueFormats()	Returns the value of the sortValueFormats record component.
boolean	terminatedAfter()	Returns the value of the terminatedAfter record component.
TopDocsAndMaxScore	topDocsAndMaxScore()	Returns the value of the topDocsAndMaxScore record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

QueryPhaseResult

public QueryPhaseResult(TopDocsAndMaxScore topDocsAndMaxScore,
 DocValueFormat[] sortValueFormats,
 boolean terminatedAfter,
 CollectorResult collectorResult)

Creates an instance of a QueryPhaseResult record class.

Parameters:

topDocsAndMaxScore - the value for the topDocsAndMaxScore record component

sortValueFormats - the value for the sortValueFormats record component

terminatedAfter - the value for the terminatedAfter record component

collectorResult - the value for the collectorResult record component

Method Details

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.

topDocsAndMaxScore

public TopDocsAndMaxScore topDocsAndMaxScore()

Returns the value of the topDocsAndMaxScore record component.

Returns:

the value of the topDocsAndMaxScore record component

sortValueFormats

public DocValueFormat[] sortValueFormats()

Returns the value of the sortValueFormats record component.

Returns:

the value of the sortValueFormats record component

terminatedAfter

public boolean terminatedAfter()

Returns the value of the terminatedAfter record component.

Returns:

the value of the terminatedAfter record component

collectorResult

public CollectorResult collectorResult()

Returns the value of the collectorResult record component.

Returns:

the value of the collectorResult record component