Record Class MultiEngineQueryOptions
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.MultiEngineQueryOptions
public record MultiEngineQueryOptions(Map<String, DataPointQueryOptions<?>> perEngine, TimeRange timeRange)
extends Record
Query envelope that carries different query options per engine in one pipeline call, instead of
one call per engine.
Each entry of perEngine() maps an engine's histprov identifier to that engine's query
options — raw or aggregated. The pipeline dispatches keys through QueryEngineRouter.engineFor(String) and reads the options appropriate to each engine. Iteration
follows the caller's order, which orders a Calculation's rows and columns and a Wide result's
columns.
The time range is shared by the whole binding; per-key range overrides on the underlying options still apply.
Immutable. Thread-safe.
-
Constructor Summary
ConstructorsConstructorDescriptionMultiEngineQueryOptions(Map<String, DataPointQueryOptions<?>> perEngine, TimeRange timeRange) Creates an instance of aMultiEngineQueryOptionsrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.Returns the value of theperEnginerecord component.Returns the value of thetimeRangerecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
MultiEngineQueryOptions
public MultiEngineQueryOptions(Map<String, DataPointQueryOptions<?>> perEngine, TimeRange timeRange) Creates an instance of aMultiEngineQueryOptionsrecord class.- Parameters:
perEngine- the value for theperEnginerecord componenttimeRange- the value for thetimeRangerecord component
-
-
Method Details
-
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). -
perEngine
Returns the value of theperEnginerecord component.- Returns:
- the value of the
perEnginerecord component
-
timeRange
Returns the value of thetimeRangerecord component.- Returns:
- the value of the
timeRangerecord component
-