Record Class BoundingOptions
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.BoundingOptions
- Record Components:
mode- the bounding mode; nevernulllookback- the search horizon for the pre-bound sample, ornullfor the default; ignored whenmoderequests no pre-boundlookforward- the search horizon for the post-bound sample, ornullfor the default; ignored whenmoderequests no post-bound
public record BoundingOptions(BoundingMode mode, @Nullable Duration lookback, @Nullable Duration lookforward)
extends Record
Bounding-value configuration: the mode and the optional lookback and
lookforward horizons the pipeline's
BoundingValueResolver uses when it must fetch
boundary samples itself. Both RawQueryOptions and AggregatedQueryOptions carry
one; NONE is the default for both.
lookback and lookforward narrow the search: null searches the full
BoundingSearchWindow.DEFAULT_LOOKBACK, and a supplied value is honored up to BoundingSearchWindow.MAX_LOOKBACK (see BoundingSearchWindow.pick(Duration)). They apply only when
mode() is not BoundingMode.NONE.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionBoundingOptions(BoundingMode mode, @Nullable Duration lookback, @Nullable Duration lookforward) Creates an instance of aBoundingOptionsrecord 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.booleanWhether this configuration requests any bounding sample fetch.@Nullable Durationlookback()Returns the value of thelookbackrecord component.@Nullable DurationReturns the value of thelookforwardrecord component.mode()Returns the value of themoderecord component.static BoundingOptionsof(BoundingMode mode) Returns bounding withmodeand the default horizons.final StringtoString()Returns a string representation of this record class.
-
Field Details
-
NONE
Requests no bounding samples.
-
-
Constructor Details
-
BoundingOptions
public BoundingOptions(BoundingMode mode, @Nullable Duration lookback, @Nullable Duration lookforward) Creates an instance of aBoundingOptionsrecord class.- Parameters:
mode- the value for themoderecord componentlookback- the value for thelookbackrecord componentlookforward- the value for thelookforwardrecord component
-
-
Method Details
-
of
Returns bounding withmodeand the default horizons. -
isEnabled
public boolean isEnabled()Whether this configuration requests any bounding sample fetch. -
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). -
mode
-
lookback
-
lookforward
Returns the value of thelookforwardrecord component.- Returns:
- the value of the
lookforwardrecord component
-