Package org.apache.flink.streaming.api.datastream

Class IterativeStream<T>

java.lang.Object

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

org.apache.flink.streaming.api.datastream.SingleOutputStreamOperator<T>

org.apache.flink.streaming.api.datastream.IterativeStream<T>

Type Parameters:

T - Type of the elements in this Stream

@PublicEvolving
public class IterativeStream<T>
extends SingleOutputStreamOperator<T>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IterativeStream.ConnectedIterativeStreams<I,F>	The IterativeStream.ConnectedIterativeStreams represent a start of an iterative part of a streaming program, where the original input of the iteration and the feedback of the iteration are connected as in a ConnectedStreams.

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.datastream.DataStream

DataStream.Collector<T>

Field Summary

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

nonParallel

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

environment, transformation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IterativeStream(DataStream<T> dataStream, long maxWaitTime)

Method Summary

Modifier and Type	Method	Description
DataStream<T>	closeWith(DataStream<T> feedbackStream)	Closes the iteration.
<F> IterativeStream.ConnectedIterativeStreams<T,F>	withFeedbackType(Class<F> feedbackTypeClass)	Changes the feedback type of the iteration and allows the user to apply co-transformations on the input and feedback stream, as in a ConnectedStreams.
<F> IterativeStream.ConnectedIterativeStreams<T,F>	withFeedbackType(org.apache.flink.api.common.typeinfo.TypeHint<F> feedbackTypeHint)	Changes the feedback type of the iteration and allows the user to apply co-transformations on the input and feedback stream, as in a ConnectedStreams.
<F> IterativeStream.ConnectedIterativeStreams<T,F>	withFeedbackType(org.apache.flink.api.common.typeinfo.TypeInformation<F> feedbackType)	Changes the feedback type of the iteration and allows the user to apply co-transformations on the input and feedback stream, as in a ConnectedStreams.

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

cache, disableChaining, forceNonParallel, getName, getSideOutput, name, returns, returns, returns, setBufferTimeout, setDescription, setMaxParallelism, setParallelism, setUidHash, slotSharingGroup, slotSharingGroup, startNewChain, uid

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

addSink, assignTimestampsAndWatermarks, assignTimestampsAndWatermarks, assignTimestampsAndWatermarks, broadcast, broadcast, clean, coGroup, collectAsync, collectAsync, connect, connect, countWindowAll, countWindowAll, doTransform, executeAndCollect, executeAndCollect, executeAndCollect, executeAndCollect, filter, flatMap, flatMap, forward, getExecutionConfig, getExecutionEnvironment, getId, getMinResources, getParallelism, getPreferredResources, getTransformation, getType, global, iterate, iterate, join, keyBy, keyBy, keyBy, keyBy, map, map, partitionCustom, partitionCustom, partitionCustom, print, print, printToErr, printToErr, process, process, project, rebalance, rescale, setConnectionType, shuffle, sinkTo, sinkTo, sinkTo, sinkTo, timeWindowAll, timeWindowAll, transform, transform, union, windowAll, writeAsCsv, writeAsCsv, writeAsCsv, writeAsText, writeAsText, writeToSocket, writeUsingOutputFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

IterativeStream

protected IterativeStream(DataStream<T> dataStream,
                          long maxWaitTime)

Method Detail

closeWith

public DataStream<T> closeWith(DataStream<T> feedbackStream)

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 ProcessFunction.Context.output(OutputTag, Object) for more information.

Parameters:

feedbackStream - DataStream that will be used as input to the iteration head.

Returns:

The feedback stream.

withFeedbackType

public <F> IterativeStream.ConnectedIterativeStreams<T,F> withFeedbackType(Class<F> feedbackTypeClass)

Changes the feedback type of the iteration and allows the user to apply co-transformations on the input and feedback stream, as in a ConnectedStreams.

For type safety the user needs to define the feedback type

Parameters:

feedbackTypeClass - Class of the elements in the feedback stream.

Returns:

A IterativeStream.ConnectedIterativeStreams.

withFeedbackType

public <F> IterativeStream.ConnectedIterativeStreams<T,F> withFeedbackType(org.apache.flink.api.common.typeinfo.TypeHint<F> feedbackTypeHint)

Changes the feedback type of the iteration and allows the user to apply co-transformations on the input and feedback stream, as in a ConnectedStreams.

For type safety the user needs to define the feedback type

Parameters:

feedbackTypeHint - Class of the elements in the feedback stream.

Returns:

A IterativeStream.ConnectedIterativeStreams.

withFeedbackType

public <F> IterativeStream.ConnectedIterativeStreams<T,F> withFeedbackType(org.apache.flink.api.common.typeinfo.TypeInformation<F> feedbackType)

Changes the feedback type of the iteration and allows the user to apply co-transformations on the input and feedback stream, as in a ConnectedStreams.

For type safety the user needs to define the feedback type

Parameters:

feedbackType - The type information of the feedback stream.

Returns:

A IterativeStream.ConnectedIterativeStreams.