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.-
Nested Class Summary
Nested classes/interfaces inherited from interface EngineCapabilities
EngineCapabilities.CapabilityDetails, EngineCapabilities.QueryCapability -
Constructor Summary
ConstructorsConstructorDescriptionEngineCapabilitiesSnapshot(String engineId, Set<EngineCapabilities.QueryCapability> capabilities, EngineCapabilities.CapabilityDetails details) Creates an instance of aEngineCapabilitiesSnapshotrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thecapabilitiesrecord component.details()Returns the value of thedetailsrecord component.engineId()Returns the value of theengineIdrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.static EngineCapabilitiesSnapshotof(EngineCapabilities source) Returns a snapshot of the given capabilities.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
EngineCapabilitiesSnapshot
public EngineCapabilitiesSnapshot(String engineId, Set<EngineCapabilities.QueryCapability> capabilities, EngineCapabilities.CapabilityDetails details) Creates an instance of aEngineCapabilitiesSnapshotrecord class.- Parameters:
engineId- the value for theengineIdrecord componentcapabilities- the value for thecapabilitiesrecord componentdetails- the value for thedetailsrecord component
-
-
Method Details
-
of
Returns a snapshot of the given capabilities.- Parameters:
source- the capabilities to snapshot.- Returns:
sourceitself if it is already a snapshot, otherwise a copy.
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object). -
engineId
Returns the value of theengineIdrecord component.- Specified by:
engineIdin interfaceEngineCapabilities- Returns:
- the value of the
engineIdrecord component
-
capabilities
Returns the value of thecapabilitiesrecord component.- Specified by:
capabilitiesin interfaceEngineCapabilities- Returns:
- the value of the
capabilitiesrecord component
-
details
Returns the value of thedetailsrecord component.- Specified by:
detailsin interfaceEngineCapabilities- Returns:
- the value of the
detailsrecord component
-