Record Class BatchedDefinitionResolver.FlushResult

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storage.BatchedDefinitionResolver.FlushResult
Record Components:
pathToId - the backend-assigned id for each resolved path.
failedPaths - the paths that failed to write.
Enclosing class:
BatchedDefinitionResolver<N extends HistoricalNode & Comparable<? super N>>

public static record BatchedDefinitionResolver.FlushResult(Map<String, HistoricalNodeId> pathToId, Set<String> failedPaths) extends Record
The outcome of a definition flush. A path is never both resolved and failed: a path in failedPaths is dropped from pathToId at construction.
  • Constructor Details

    • FlushResult

      public FlushResult(Map<String, HistoricalNodeId> pathToId, Set<String> failedPaths)
      Creates an instance of a FlushResult record class.
      Parameters:
      pathToId - the value for the pathToId record component
      failedPaths - the value for the failedPaths record component
  • Method Details

    • idFor

      public @Nullable HistoricalNodeId idFor(String path)
      Resolved id for path, or null if it failed or was not in this batch.
    • 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.
    • pathToId

      public Map<String, HistoricalNodeId> pathToId()
      Returns the value of the pathToId record component.
      Returns:
      the value of the pathToId record component
    • failedPaths

      public Set<String> failedPaths()
      Returns the value of the failedPaths record component.
      Returns:
      the value of the failedPaths record component