org.apache.flink.streaming.runtime.operators

Class TimestampsAndPeriodicWatermarksOperator<T>

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<OUT>

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<T,AssignerWithPeriodicWatermarks<T>>

org.apache.flink.streaming.runtime.operators.TimestampsAndPeriodicWatermarksOperator<T>

Type Parameters:

T - The type of the input elements

All Implemented Interfaces:

Serializable, org.apache.flink.runtime.state.CheckpointListener, KeyContext, OneInputStreamOperator<T,T>, OutputTypeConfigurable<T>, SetupableStreamOperator<T>, StreamOperator<T>, ProcessingTimeCallback, org.apache.flink.util.Disposable

public class TimestampsAndPeriodicWatermarksOperator<T>
extends AbstractUdfStreamOperator<T,AssignerWithPeriodicWatermarks<T>>
implements OneInputStreamOperator<T,T>, ProcessingTimeCallback

A stream operator that extracts timestamps from stream elements and generates periodic watermarks.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

AbstractStreamOperator.CountingOutput<OUT>

Field Summary

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator

userFunction

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

chainingStrategy, config, latencyStats, LOG, metrics, output, timeServiceManager

Constructor Summary

Constructors

Constructor and Description
TimestampsAndPeriodicWatermarksOperator(AssignerWithPeriodicWatermarks<T> assigner)

Method Summary

Modifier and Type	Method and Description
void	close() This method is called after all records have been added to the operators via the methods OneInputStreamOperator.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).
void	onProcessingTime(long timestamp) This method is invoked with the timestamp for which the trigger was scheduled.
void	open() This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g.
void	processElement(StreamRecord<T> element) Processes one element that arrived at this operator.
void	processWatermark(Watermark mark) Override the base implementation to completely ignore watermarks propagated from upstream (we rely only on the AssignerWithPeriodicWatermarks to emit watermarks from here).

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator

dispose, getUserFunction, getUserFunctionParameters, initializeState, notifyCheckpointComplete, setOutputType, setup, snapshotState

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getUserCodeClassloader, initializeState, numEventTimeTimers, numProcessingTimeTimers, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark1, processWatermark2, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, snapshotState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.streaming.api.operators.OneInputStreamOperator

processLatencyMarker

Methods inherited from interface org.apache.flink.streaming.api.operators.StreamOperator

dispose, getChainingStrategy, getMetricGroup, getOperatorID, initializeState, prepareSnapshotPreBarrier, setChainingStrategy, setKeyContextElement1, setKeyContextElement2, snapshotState

Methods inherited from interface org.apache.flink.runtime.state.CheckpointListener

notifyCheckpointComplete

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContext

getCurrentKey, setCurrentKey

Constructor Detail

TimestampsAndPeriodicWatermarksOperator

public TimestampsAndPeriodicWatermarksOperator(AssignerWithPeriodicWatermarks<T> assigner)

Method Detail

open

public void open()
          throws Exception

Description copied from class: AbstractStreamOperator

This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<T>

Overrides:

open in class AbstractUdfStreamOperator<T,AssignerWithPeriodicWatermarks<T>>

Throws:

Exception - An exception in this method causes the operator to fail.

processElement

public void processElement(StreamRecord<T> element)
                    throws Exception

Description copied from interface: OneInputStreamOperator

Processes one element that arrived at this operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processElement in interface OneInputStreamOperator<T,T>

Throws:

Exception

onProcessingTime

public void onProcessingTime(long timestamp)
                      throws Exception

Description copied from interface: ProcessingTimeCallback

This method is invoked with the timestamp for which the trigger was scheduled.

If the triggering is delayed for whatever reason (trigger timer was blocked, JVM stalled due to a garbage collection), the timestamp supplied to this function will still be the original timestamp for which the trigger was scheduled.

Specified by:

onProcessingTime in interface ProcessingTimeCallback

Parameters:

timestamp - The timestamp for which the trigger event was scheduled.

Throws:

Exception

processWatermark

public void processWatermark(Watermark mark)
                      throws Exception

Override the base implementation to completely ignore watermarks propagated from upstream (we rely only on the AssignerWithPeriodicWatermarks to emit watermarks from here).

Specified by:

processWatermark in interface OneInputStreamOperator<T,T>

Overrides:

processWatermark in class AbstractStreamOperator<T>

Throws:

Exception

See Also:

Watermark

close

public void close()
           throws Exception

Description copied from class: AbstractStreamOperator

This method is called after all records have been added to the operators via the methods OneInputStreamOperator.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).

The method is expected to flush all remaining buffered data. Exceptions during this flushing of buffered should be propagated, in order to cause the operation to be recognized asa failed, because the last data items are not processed properly.

Specified by:

close in interface StreamOperator<T>

Overrides:

close in class AbstractUdfStreamOperator<T,AssignerWithPeriodicWatermarks<T>>

Throws:

Exception - An exception in this method causes the operator to fail.