Class TumblingWindows<L>
java.lang.Object
org.apache.storm.streams.windowing.BaseWindow<L,L>
org.apache.storm.streams.windowing.TumblingWindows<L>
- Type Parameters:
L
- the type of the length of the window (e.g Count, Duration)
- All Implemented Interfaces:
Serializable
,Window<L,
L>
A tumbling window specification. The window tumbles after the specified window length.
- See Also:
-
Field Summary
Fields inherited from class org.apache.storm.streams.windowing.BaseWindow
lag, lateTupleStream, timestampField
-
Method Summary
Modifier and TypeMethodDescriptionboolean
The sliding interval of the window.The length of the window.int
hashCode()
of
(BaseWindowedBolt.Count count) A count based tumbling window.of
(BaseWindowedBolt.Duration duration) A time duration based tumbling window.withLag
(BaseWindowedBolt.Duration duration) Specify the maximum time lag of the tuple timestamp in milliseconds.withLateTupleStream
(String streamId) Specify a stream id on which late tuples are going to be emitted.withTimestampField
(String fieldName) The name of the field in the tuple that contains the timestamp when the event occurred as a long value.Methods inherited from class org.apache.storm.streams.windowing.BaseWindow
getLag, getLateTupleStream, getTimestampField
-
Method Details
-
of
A count based tumbling window.- Parameters:
count
- the number of tuples after which the window tumbles
-
of
A time duration based tumbling window.- Parameters:
duration
- the time duration after which the window tumbles
-
getWindowLength
Description copied from interface:Window
The length of the window.- Returns:
- the window length
-
getSlidingInterval
Description copied from interface:Window
The sliding interval of the window.- Returns:
- the sliding interval
-
withTimestampField
The name of the field in the tuple that contains the timestamp when the event occurred as a long value. This is used of event-time based processing. If this config is set and the field is not present in the incoming tuple, anIllegalArgumentException
will be thrown.- Parameters:
fieldName
- the name of the field that contains the timestamp
-
withLateTupleStream
Specify a stream id on which late tuples are going to be emitted. They are going to be accessible via theWindowedBoltExecutor.LATE_TUPLE_FIELD
field. It must be defined on a per-component basis, and in conjunction with theBaseWindowedBolt.withTimestampField(java.lang.String)
, otherwiseIllegalArgumentException
will be thrown.- Parameters:
streamId
- the name of the stream used to emit late tuples on
-
withLag
Specify the maximum time lag of the tuple timestamp in milliseconds. It means that the tuple timestamps cannot be out of order by more than this amount.- Parameters:
duration
- the max lag duration
-
equals
- Overrides:
equals
in classBaseWindow<L,
L>
-
hashCode
public int hashCode()- Overrides:
hashCode
in classBaseWindow<L,
L>
-