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 Details

    • QueryResult

      public QueryResult(long rowCount, Duration elapsed, QualityCode terminalQuality, @Nullable Throwable error)
      Creates an instance of a QueryResult record class.
      Parameters:
      rowCount - the value for the rowCount record component
      elapsed - the value for the elapsed record component
      terminalQuality - the value for the terminalQuality record component
      error - the value for the error 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 the compare method from their corresponding wrapper classes.
      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.
    • rowCount

      public long rowCount()
      Returns the value of the rowCount record component.
      Returns:
      the value of the rowCount record component
    • elapsed

      public Duration elapsed()
      Returns the value of the elapsed record component.
      Returns:
      the value of the elapsed record component
    • terminalQuality

      public QualityCode terminalQuality()
      Returns the value of the terminalQuality record component.
      Returns:
      the value of the terminalQuality record component
    • error

      public @Nullable Throwable error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component