Record Class PipelineEvent.KeyFailure<K extends DataPointQueryKey>

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.PipelineEvent.KeyFailure<K>
All Implemented Interfaces:
PipelineEvent<K>
Enclosing interface:
PipelineEvent<K extends DataPointQueryKey>

public static record PipelineEvent.KeyFailure<K extends DataPointQueryKey>(K extends DataPointQueryKey key, QualityCode code) extends Record implements PipelineEvent<K>
Signals that the stream for key() failed with the given quality code.
  • Constructor Details

    • KeyFailure

      public KeyFailure(K key, QualityCode code)
      Creates an instance of a KeyFailure record class.
      Parameters:
      key - the value for the key record component
      code - the value for the code 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.
    • key

      public K key()
      Returns the value of the key record component.
      Specified by:
      key in interface PipelineEvent<K extends DataPointQueryKey>
      Returns:
      the value of the key record component
    • code

      public QualityCode code()
      Returns the value of the code record component.
      Returns:
      the value of the code record component