Package org.apache.flink.streaming.api.operators

Interface Input<IN>

All Known Subinterfaces:

OneInputStreamOperator<IN,OUT>

All Known Implementing Classes:

AsyncEvictingWindowOperator, AsyncKeyedProcessOperator, AsyncStreamFlatMap, AsyncWindowOperator, BatchGroupedReduceOperator, CacheTransformationTranslator.IdentityStreamOperator, CacheTransformationTranslator.NoOpStreamOperator, CollectSinkOperator, ContinuousFileReaderOperator, EvictingWindowOperator, FinishedOnRestoreInput, GlobalCommitterOperator, KeyedProcessOperator, KeyedSortPartitionOperator, LegacyKeyedProcessOperator, MapPartitionOperator, PartitionAggregateOperator, PartitionReduceOperator, ProcessOperator, QueryableAppendingStateOperator, QueryableValueStateOperator, SortPartitionOperator, StreamFilter, StreamFlatMap, StreamGroupedReduceAsyncStateOperator, StreamGroupedReduceOperator, StreamMap, StreamProject, StreamSink, TimestampsAndWatermarksOperator, WindowOperator

@PublicEvolving
public interface Input<IN>

Input interface used in MultipleInputStreamOperator. Most likely you don't want to implement this interface on your own. Instead you can use AbstractInput and AbstractStreamOperatorV2 to implement MultipleInputStreamOperator, or just AbstractStreamOperatorV2 to implement OneInputStreamOperator.

Method Summary

Modifier and Type	Method	Description
void	processElement(StreamRecord<IN> element)	Processes one element that arrived on this input of the MultipleInputStreamOperator.
void	processLatencyMarker(LatencyMarker latencyMarker)	Processes a LatencyMarker that arrived on the first input of this two-input operator.
default void	processRecordAttributes(RecordAttributes recordAttributes)	Processes a RecordAttributes that arrived at this input.
default void	processWatermark(WatermarkEvent watermark)	Processes a Watermark that arrived at this input, wrapped in a WatermarkEvent.
void	processWatermark(Watermark mark)	Processes a Watermark that arrived on the first input of this two-input operator.
void	processWatermarkStatus(WatermarkStatus watermarkStatus)	Processes a WatermarkStatus that arrived on this input of the MultipleInputStreamOperator.
void	setKeyContextElement(StreamRecord<IN> record)	Set the correct key context before processing the record.

Method Detail

processElement

void processElement(StreamRecord<IN> element)
             throws Exception

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

Throws:

Exception

processWatermark

void processWatermark(Watermark mark)
               throws Exception

Processes a Watermark that arrived on the first input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Throws:

Exception

See Also:

Watermark

processWatermarkStatus

void processWatermarkStatus(WatermarkStatus watermarkStatus)
                     throws Exception

Processes a WatermarkStatus that arrived on this input of the MultipleInputStreamOperator. This method is guaranteed to not be called concurrently with other methods of the operator.

Throws:

Exception

See Also:

WatermarkStatus

processLatencyMarker

void processLatencyMarker(LatencyMarker latencyMarker)
                   throws Exception

Processes a LatencyMarker that arrived on the first input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Throws:

Exception

See Also:

LatencyMarker

setKeyContextElement

void setKeyContextElement(StreamRecord<IN> record)
                   throws Exception

Set the correct key context before processing the record. Used for example to extract key from the record and pass that key to the state backends. This method is guaranteed to not be called concurrently with other methods of the operator.

Throws:

Exception

processRecordAttributes

@Experimental
default void processRecordAttributes(RecordAttributes recordAttributes)
                              throws Exception

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

Throws:

Exception

processWatermark

@Experimental
default void processWatermark(WatermarkEvent watermark)
                       throws Exception

Processes a Watermark that arrived at this input, wrapped in a WatermarkEvent.

Throws:

Exception