Record Class HistorianQueryRunner.Result

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.binding.HistorianQueryRunner.Result
Enclosing interface:
HistorianQueryRunner

public static record HistorianQueryRunner.Result(QualifiedValue envelope, Map<String,Instant> perKeyTerminalTs, @Nullable AutoCloseable streamCloser) extends Record
The outcome of a fetch: the envelope, the per-key terminal timestamps for cursor advancement, and a closer for STREAMING resources. perKeyTerminalTs is copied immutably. streamCloser is null except for STREAMING, where it holds the live RowToPublisherAdapter so the binding can cancel the pipeline on the next tick or on shutdown.
  • Constructor Details

    • Result

      public Result(QualifiedValue envelope, Map<String,Instant> perKeyTerminalTs)
      Creates a result with no stream closer, for non-STREAMING formats.
    • Result

      public Result(QualifiedValue envelope, Map<String,Instant> perKeyTerminalTs, @Nullable AutoCloseable streamCloser)
      Creates an instance of a Result record class.
      Parameters:
      envelope - the value for the envelope record component
      perKeyTerminalTs - the value for the perKeyTerminalTs record component
      streamCloser - the value for the streamCloser 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.
    • envelope

      public QualifiedValue envelope()
      Returns the value of the envelope record component.
      Returns:
      the value of the envelope record component
    • perKeyTerminalTs

      public Map<String,Instant> perKeyTerminalTs()
      Returns the value of the perKeyTerminalTs record component.
      Returns:
      the value of the perKeyTerminalTs record component
    • streamCloser

      public @Nullable AutoCloseable streamCloser()
      Returns the value of the streamCloser record component.
      Returns:
      the value of the streamCloser record component