org.apache.flink.streaming.api.datastream

Class IterativeDataStream<IN>

java.lang.Object

org.apache.flink.streaming.api.datastream.DataStream<OUT>

org.apache.flink.streaming.api.datastream.SingleOutputStreamOperator<IN,IterativeDataStream<IN>>

org.apache.flink.streaming.api.datastream.IterativeDataStream<IN>

Type Parameters:

IN - Type of the DataStream

public class IterativeDataStream<IN>
extends SingleOutputStreamOperator<IN,IterativeDataStream<IN>>

The iterative data stream represents the start of an iteration in a DataStream.

Field Summary

Fields inherited from class org.apache.flink.streaming.api.datastream.SingleOutputStreamOperator

isSplit, operator

Fields inherited from class org.apache.flink.streaming.api.datastream.DataStream

counter, environment, id, iterationID, iterationWaitTime, parallelism, partitioner, streamGraph, typeInfo, unionizedStreams, userDefinedNames

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IterativeDataStream(DataStream<IN> dataStream, long maxWaitTime)

Method Summary

Modifier and Type	Method and Description
DataStream<IN>	closeWith(DataStream<IN> iterationTail) Closes the iteration.
DataStream<IN>	closeWith(DataStream<IN> iterationTail, boolean keepPartitioning) Closes the iteration.

Methods inherited from class org.apache.flink.streaming.api.datastream.SingleOutputStreamOperator

broadcast, copy, disableChaining, forward, getName, global, isolateResources, name, rebalance, returns, returns, returns, setBufferTimeout, setParallelism, shuffle, startNewChain, startNewResourceGroup

Methods inherited from class org.apache.flink.streaming.api.datastream.DataStream

addSink, aggregate, checkFieldRange, clean, connect, connectGraph, count, cross, every, fillInType, filter, flatMap, fold, getClassAtPos, getExecutionConfig, getExecutionEnvironment, getId, getParallelism, getType, groupBy, groupBy, groupBy, iterate, iterate, join, map, max, max, maxBy, maxBy, maxBy, maxBy, min, min, minBy, minBy, minBy, minBy, partitionByHash, partitionByHash, partitionByHash, print, printToErr, project, reduce, setConnectionType, split, sum, sum, transform, union, window, window, write, writeAsCsv, writeAsCsv, writeAsCsv, writeAsCsv, writeAsText, writeAsText, writeAsText, writeAsText, writeToSocket

Methods inherited from class java.lang.Object

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

Constructor Detail

IterativeDataStream

protected IterativeDataStream(DataStream<IN> dataStream,
                              long maxWaitTime)

Method Detail

closeWith

public DataStream<IN> closeWith(DataStream<IN> iterationTail,
                                boolean keepPartitioning)

Closes the iteration. This method defines the end of the iterative program part that will be fed back to the start of the iteration.

A common usage pattern for streaming iterations is to use output splitting to send a part of the closing data stream to the head. Refer to DataStream.split(org.apache.flink.streaming.api.collector.selector.OutputSelector) for more information.

Parameters:

iterationTail - The data stream that is fed back to the next iteration head.

keepPartitioning - If true the feedback partitioning will be kept as it is (not changed to match the input of the iteration head)

Returns:

Returns the stream that was fed back to the iteration. In most cases no further transformation are applied on this stream.

closeWith

public DataStream<IN> closeWith(DataStream<IN> iterationTail)

Closes the iteration. This method defines the end of the iterative program part that will be fed back to the start of the iteration.

A common usage pattern for streaming iterations is to use output splitting to send a part of the closing data stream to the head. Refer to DataStream.split(org.apache.flink.streaming.api.collector.selector.OutputSelector) for more information.

Parameters:

iterationTail - The data stream that is fed back to the next iteration head.

Returns:

Returns the stream that was fed back to the iteration. In most cases no further transformation are applied on this stream.