Module org.elasticsearch.compute
Record Class DriverCompletionInfo
java.lang.Object
java.lang.Record
org.elasticsearch.compute.operator.DriverCompletionInfo
- Record Components:
documentsFound- The number of documents found by all lucene queries performed by these drivers.valuesLoaded- The number of values loaded from lucene for all drivers. This is roughly the number of documents times the number of fields per document. Exceptnullvalues don't count. And multivalued fields count as many times as there are values.driverProfiles-DriverProfiles from each driver. These are fairly cheap to build but not free so this will be empty if theprofileoption was not set in the request.
- All Implemented Interfaces:
Writeable
public record DriverCompletionInfo(long documentsFound, long valuesLoaded, List<DriverProfile> driverProfiles, List<PlanProfile> planProfiles)
extends Record
implements Writeable
Information returned when one of more
Drivers is completed.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DriverCompletionInfoCompletion info we use when we didn't properly complete any drivers. -
Constructor Summary
ConstructorsConstructorDescriptionDriverCompletionInfo(long documentsFound, long valuesLoaded, List<DriverProfile> driverProfiles, List<PlanProfile> planProfiles) Creates an instance of aDriverCompletionInforecord class. -
Method Summary
Modifier and TypeMethodDescriptionlongReturns the value of thedocumentsFoundrecord component.Returns the value of thedriverProfilesrecord component.final booleanIndicates whether some other object is "equal to" this one.static DriverCompletionInfoexcludingProfiles(List<Driver> drivers) Build aDriverCompletionInfofor many drivers excluding their profile output.final inthashCode()Returns a hash code value for this object.static DriverCompletionInfoincludingProfiles(List<Driver> drivers, String description, String clusterName, String nodeName, String planTree) Build aDriverCompletionInfofor many drivers including their profile output.Returns the value of theplanProfilesrecord component.static DriverCompletionInforeadFrom(StreamInput in) final StringtoString()Returns a string representation of this record class.longReturns the value of thevaluesLoadedrecord component.voidwriteTo(StreamOutput out)
-
Field Details
-
EMPTY
Completion info we use when we didn't properly complete any drivers. Usually this is returned with an error, but it's also used when receiving responses from very old nodes.
-
-
Constructor Details
-
DriverCompletionInfo
public DriverCompletionInfo(long documentsFound, long valuesLoaded, List<DriverProfile> driverProfiles, List<PlanProfile> planProfiles) Creates an instance of aDriverCompletionInforecord class.- Parameters:
documentsFound- the value for thedocumentsFoundrecord componentvaluesLoaded- the value for thevaluesLoadedrecord componentdriverProfiles- the value for thedriverProfilesrecord componentplanProfiles- the value for theplanProfilesrecord component
-
-
Method Details
-
includingProfiles
public static DriverCompletionInfo includingProfiles(List<Driver> drivers, String description, String clusterName, String nodeName, String planTree) Build aDriverCompletionInfofor many drivers including their profile output. -
excludingProfiles
Build aDriverCompletionInfofor many drivers excluding their profile output. -
readFrom
- Throws:
IOException
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
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. -
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. -
equals
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 withObjects::equals(Object,Object); primitive components are compared with '=='. -
documentsFound
public long documentsFound()Returns the value of thedocumentsFoundrecord component.- Returns:
- the value of the
documentsFoundrecord component
-
valuesLoaded
public long valuesLoaded()Returns the value of thevaluesLoadedrecord component.- Returns:
- the value of the
valuesLoadedrecord component
-
driverProfiles
Returns the value of thedriverProfilesrecord component.- Returns:
- the value of the
driverProfilesrecord component
-
planProfiles
Returns the value of theplanProfilesrecord component.- Returns:
- the value of the
planProfilesrecord component
-