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

Deprecated.

This method is deprecated since Flink 1.19. The only known use case of this Iteration API comes from Flink ML, which already has its own implementation of iteration and no longer uses this API. If there's any use cases other than Flink ML that needs iteration support, please reach out to dev@flink.apache.org and we can consider making the Flink ML iteration implementation a separate common library.

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

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

See Also:

FLIP-357: Deprecate Iteration API of DataStream , Flink ML

Nested Class Summary

Nested Classes

Modifier and Type

Class and Description

static class

IterativeStream.ConnectedIterativeStreams<I,F> Deprecated. This method is deprecated since Flink 1.19. The only known use case of this Iteration API comes from Flink ML, which already has its own implementation of iteration and no longer uses this API. If there's any use cases other than Flink ML that needs iteration support, please reach out to dev@flink.apache.org and we can consider making the Flink ML iteration implementation a separate common library.

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 and Description
protected	IterativeStream(DataStream<T> dataStream, long maxWaitTime) Deprecated.

Method Summary

Modifier and Type	Method and Description
DataStream<T>	closeWith(DataStream<T> feedbackStream) Deprecated. Closes the iteration.
PartitionWindowedStream<T>	fullWindowPartition() Deprecated. Collect records from each partition into a separate full window.
<F> IterativeStream.ConnectedIterativeStreams<T,F>	withFeedbackType(Class<F> feedbackTypeClass) Deprecated. 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(TypeHint<F> feedbackTypeHint) Deprecated. 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(TypeInformation<F> feedbackType) Deprecated. 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)

Deprecated.

Method Detail

closeWith

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

Deprecated.

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)

Deprecated.

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(TypeHint<F> feedbackTypeHint)

Deprecated.

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(TypeInformation<F> feedbackType)

Deprecated.

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.

fullWindowPartition

public PartitionWindowedStream<T> fullWindowPartition()

Deprecated.

Description copied from class: DataStream

Collect records from each partition into a separate full window. The window emission will be triggered at the end of inputs. For this non-keyed data stream(each record has no key), a partition contains all records of a subtask.

Overrides:

fullWindowPartition in class DataStream<T>

Returns:

The full windowed data stream on partition.