Record Class WindowAssigner.Tumbling
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.WindowAssigner.Tumbling
- Record Components:
sizeMs- the window size in milliseconds;> 0startMs- the alignment epoch, typically the query's start time in epoch milliseconds
- All Implemented Interfaces:
WindowAssigner
- Enclosing interface:
WindowAssigner
public static record WindowAssigner.Tumbling(long sizeMs, long startMs)
extends Record
implements WindowAssigner
Fixed-size, non-overlapping windows aligned to
startMs. When built from a
TimeWindow in MONTHS or YEARS, boundaries use the unit's average duration and
do not align with the calendar; the engine resolves calendar alignment before constructing this
assigner.-
Nested Class Summary
Nested classes/interfaces inherited from interface WindowAssigner
WindowAssigner.Natural, WindowAssigner.Raw, WindowAssigner.Tumbling -
Constructor Summary
ConstructorsConstructorDescriptionTumbling(long sizeMs, long startMs) Creates an instance of aTumblingrecord class. -
Method Summary
Modifier and TypeMethodDescriptionlongassignWindow(long timestamp) Assigns a timestamp to the start of its window.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.longsizeMs()Returns the value of thesizeMsrecord component.longstartMs()Returns the value of thestartMsrecord component.final StringtoString()Returns a string representation of this record class.longReturns the window size in milliseconds;0means one window per event and onlyWindowAssigner.Rawreturns it.
-
Constructor Details
-
Tumbling
-
-
Method Details
-
assignWindow
public long assignWindow(long timestamp) Description copied from interface:WindowAssignerAssigns a timestamp to the start of its window.- Specified by:
assignWindowin interfaceWindowAssigner- Parameters:
timestamp- the event timestamp in epoch milliseconds- Returns:
- the window start in epoch milliseconds;
WindowAssigner.Rawreturns the input
-
windowSize
public long windowSize()Description copied from interface:WindowAssignerReturns the window size in milliseconds;0means one window per event and onlyWindowAssigner.Rawreturns it.- Specified by:
windowSizein interfaceWindowAssigner
-
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 with thecomparemethod from their corresponding wrapper classes. -
sizeMs
-
startMs
-