Record Class EngineCapabilitiesSnapshot

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.query.EngineCapabilitiesSnapshot
Record Components:
engineId - the engine type identifier.
capabilities - the declared capability flags; copied into an unmodifiable set.
details - the capability detail values.
All Implemented Interfaces:
EngineCapabilities

public record EngineCapabilitiesSnapshot(String engineId, Set<EngineCapabilities.QueryCapability> capabilities, EngineCapabilities.CapabilityDetails details) extends Record implements EngineCapabilities
Immutable, concrete EngineCapabilities value, for carrying capabilities across a serialization boundary such as the gateway network, which an engine's own implementation cannot cross.
  • Constructor Details

  • Method Details

    • of

      Returns a snapshot of the given capabilities.
      Parameters:
      source - the capabilities to snapshot.
      Returns:
      source itself if it is already a snapshot, otherwise a copy.
    • 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.
    • engineId

      public String engineId()
      Returns the value of the engineId record component.
      Specified by:
      engineId in interface EngineCapabilities
      Returns:
      the value of the engineId record component
    • capabilities

      public Set<EngineCapabilities.QueryCapability> capabilities()
      Returns the value of the capabilities record component.
      Specified by:
      capabilities in interface EngineCapabilities
      Returns:
      the value of the capabilities record component
    • details

      Returns the value of the details record component.
      Specified by:
      details in interface EngineCapabilities
      Returns:
      the value of the details record component