Record Class QueryResult
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.QueryResult
public record QueryResult(long rowCount, Duration elapsed, QualityCode terminalQuality, @Nullable Throwable error)
extends Record
Final result of a
QueryPipeline run. Returned via QueryHandle.result().-
Constructor Summary
ConstructorsConstructorDescriptionQueryResult(long rowCount, Duration elapsed, QualityCode terminalQuality, @Nullable Throwable error) Creates an instance of aQueryResultrecord class. -
Method Summary
Modifier and TypeMethodDescriptionelapsed()Returns the value of theelapsedrecord component.final booleanIndicates whether some other object is "equal to" this one.@Nullable Throwableerror()Returns the value of theerrorrecord component.final inthashCode()Returns a hash code value for this object.longrowCount()Returns the value of therowCountrecord component.Returns the value of theterminalQualityrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
QueryResult
public QueryResult(long rowCount, Duration elapsed, QualityCode terminalQuality, @Nullable Throwable error) Creates an instance of aQueryResultrecord class.- Parameters:
rowCount- the value for therowCountrecord componentelapsed- the value for theelapsedrecord componentterminalQuality- the value for theterminalQualityrecord componenterror- the value for theerrorrecord component
-
-
Method Details
-
toString
-
hashCode
-
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 thecomparemethod from their corresponding wrapper classes. -
rowCount
public long rowCount()Returns the value of therowCountrecord component.- Returns:
- the value of the
rowCountrecord component
-
elapsed
Returns the value of theelapsedrecord component.- Returns:
- the value of the
elapsedrecord component
-
terminalQuality
Returns the value of theterminalQualityrecord component.- Returns:
- the value of the
terminalQualityrecord component
-
error
Returns the value of theerrorrecord component.- Returns:
- the value of the
errorrecord component
-