org.apache.flink.streaming.runtime.operators.windowing

Class EvictingWindowOperator<K,IN,OUT,W extends Window>

java.lang.Object

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

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT,InternalWindowFunction<ACC,OUT,K,W>>

org.apache.flink.streaming.runtime.operators.windowing.WindowOperator<K,IN,Iterable<IN>,OUT,W>

org.apache.flink.streaming.runtime.operators.windowing.EvictingWindowOperator<K,IN,OUT,W>

Type Parameters:

K - The type of key returned by the KeySelector.

IN - The type of the incoming elements.

OUT - The type of elements emitted by the InternalWindowFunction.

W - The type of Window that the WindowAssigner assigns.

All Implemented Interfaces:

Serializable, org.apache.flink.runtime.state.CheckpointListener, KeyContext, OneInputStreamOperator<IN,OUT>, OutputTypeConfigurable<OUT>, SetupableStreamOperator<OUT>, StreamOperator<OUT>, Triggerable<K,W>, org.apache.flink.util.Disposable

@Internal
public class EvictingWindowOperator<K,IN,OUT,W extends Window>
extends WindowOperator<K,IN,Iterable<IN>,OUT,W>

A WindowOperator that also allows an Evictor to be used.

The Evictor is used to remove elements from a pane before/after the evaluation of InternalWindowFunction and after the window evaluation gets triggered by a Trigger.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.runtime.operators.windowing.WindowOperator

WindowOperator.AbstractPerWindowStateStore, WindowOperator.Context, WindowOperator.MergingWindowStateStore, WindowOperator.PerWindowStateStore, WindowOperator.Timer<K,W extends Window>, WindowOperator.WindowContext

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.runtime.operators.windowing.WindowOperator

allowedLateness, internalTimerService, keySerializer, lateDataOutputTag, numLateRecordsDropped, processContext, timestampedCollector, triggerContext, windowAssigner, windowAssignerContext, windowSerializer

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

EvictingWindowOperator(WindowAssigner<? super IN,W> windowAssigner, org.apache.flink.api.common.typeutils.TypeSerializer<W> windowSerializer, org.apache.flink.api.java.functions.KeySelector<IN,K> keySelector, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.ListState<StreamRecord<IN>>,?> windowStateDescriptor, InternalWindowFunction<Iterable<IN>,OUT,K,W> windowFunction, Trigger<? super IN,? super W> trigger, Evictor<? super IN,? super W> evictor, long allowedLateness, org.apache.flink.util.OutputTag<IN> lateDataOutputTag)

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	dispose() This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.
Evictor<? super IN,? super W>	getEvictor()
org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.AppendingState<IN,Iterable<IN>>,?>	getStateDescriptor()
void	onEventTime(InternalTimer<K,W> timer) Invoked when an event-time timer fires.
void	onProcessingTime(InternalTimer<K,W> timer) Invoked when a processing-time timer fires.
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<IN> element) Processes one element that arrived at this operator.

Methods inherited from class org.apache.flink.streaming.runtime.operators.windowing.WindowOperator

deleteCleanupTimer, getKeySelector, getMergingWindowSet, getTrigger, getWindowAssigner, isCleanupTime, isElementLate, isWindowLate, registerCleanupTimer, sideOutput

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

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, processWatermark, 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, processWatermark

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

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

EvictingWindowOperator

public EvictingWindowOperator(WindowAssigner<? super IN,W> windowAssigner,
                              org.apache.flink.api.common.typeutils.TypeSerializer<W> windowSerializer,
                              org.apache.flink.api.java.functions.KeySelector<IN,K> keySelector,
                              org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                              org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.ListState<StreamRecord<IN>>,?> windowStateDescriptor,
                              InternalWindowFunction<Iterable<IN>,OUT,K,W> windowFunction,
                              Trigger<? super IN,? super W> trigger,
                              Evictor<? super IN,? super W> evictor,
                              long allowedLateness,
                              org.apache.flink.util.OutputTag<IN> lateDataOutputTag)

Method Detail

processElement

public void processElement(StreamRecord<IN> 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<IN,OUT>

Overrides:

processElement in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

Exception

onEventTime

public void onEventTime(InternalTimer<K,W> timer)
                 throws Exception

Description copied from interface: Triggerable

Invoked when an event-time timer fires.

Specified by:

onEventTime in interface Triggerable<K,W extends Window>

Overrides:

onEventTime in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

Exception

onProcessingTime

public void onProcessingTime(InternalTimer<K,W> timer)
                      throws Exception

Description copied from interface: Triggerable

Invoked when a processing-time timer fires.

Specified by:

onProcessingTime in interface Triggerable<K,W extends Window>

Overrides:

onProcessingTime in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

Exception

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<OUT>

Overrides:

open in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

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

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<OUT>

Overrides:

close in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

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

dispose

public void dispose()
             throws Exception

Description copied from class: AbstractStreamOperator

This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.

This method is expected to make a thorough effort to release all resources that the operator has acquired.

Specified by:

dispose in interface StreamOperator<OUT>

Specified by:

dispose in interface org.apache.flink.util.Disposable

Overrides:

dispose in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

Exception

getEvictor

@VisibleForTesting
public Evictor<? super IN,? super W> getEvictor()

getStateDescriptor

@VisibleForTesting
public org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.AppendingState<IN,Iterable<IN>>,?> getStateDescriptor()

Overrides:

getStateDescriptor in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>