Deprecated API

Contents

• Interfaces
• Classes
• Enums
• Fields
• Methods

Interfaces

Interface	Description
org.apache.flink.streaming.api.checkpoint.ExternallyInducedSource	This interface is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.checkpoint.ListCheckpointed	If you need to do non-keyed state snapshots of your operator, use CheckpointedFunction. This should only be needed in rare cases, though.
org.apache.flink.streaming.api.functions.AssignerWithPeriodicWatermarks
org.apache.flink.streaming.api.functions.AssignerWithPunctuatedWatermarks
org.apache.flink.streaming.api.functions.source.ParallelSourceFunction	This interface is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.SourceFunction	This interface will be removed in future versions. Use the new Source interface instead. NOTE: All sub-tasks from FLINK-28045 must be closed before this API can be completely removed.
org.apache.flink.streaming.api.functions.TimestampAssigner	use TimestampAssigner
org.apache.flink.streaming.api.operators.SetupableStreamOperator	This class is deprecated in favour of using StreamOperatorFactory and it's StreamOperatorFactory.createStreamOperator(org.apache.flink.streaming.api.operators.StreamOperatorParameters<OUT>) and passing the required parameters to the Operator's constructor in create method.
org.apache.flink.streaming.util.serialization.DeserializationSchema	Use DeserializationSchema instead.
org.apache.flink.streaming.util.serialization.SerializationSchema	Use SerializationSchema instead.

Classes

Class	Description
org.apache.flink.streaming.api.datastream.QueryableStateStream	The Queryable State feature is deprecated since Flink 1.18, and will be removed in a future Flink major version.
org.apache.flink.streaming.api.functions.AscendingTimestampExtractor	Extend AscendingTimestampExtractor instead.
org.apache.flink.streaming.api.functions.IngestionTimeExtractor
org.apache.flink.streaming.api.functions.sink.filesystem.StreamingFileSink	Use org.apache.flink.connector.file.sink.FileSink instead.
org.apache.flink.streaming.api.functions.sink.OutputFormatSinkFunction	Please use the StreamingFileSink for writing to files from a streaming program.
org.apache.flink.streaming.api.functions.sink.WriteFormat	Please use the StreamingFileSink for writing to files from a streaming program.
org.apache.flink.streaming.api.functions.sink.WriteFormatAsCsv	Please use the StreamingFileSink for writing to files from a streaming program.
org.apache.flink.streaming.api.functions.sink.WriteFormatAsText	Please use the StreamingFileSink for writing to files from a streaming program.
org.apache.flink.streaming.api.functions.sink.WriteSinkFunction	Please use the StreamingFileSink for writing to files from a streaming program.
org.apache.flink.streaming.api.functions.sink.WriteSinkFunctionByMillis	Please use the StreamingFileSink for writing to files from a streaming program.
org.apache.flink.streaming.api.functions.source.ContinuousFileMonitoringFunction	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.datagen.DataGeneratorSource	Use org.apache.flink.connector.datagen.source.DataGeneratorSource instead.
org.apache.flink.streaming.api.functions.source.FileMonitoringFunction	Internal class deprecated in favour of ContinuousFileMonitoringFunction.
org.apache.flink.streaming.api.functions.source.FileReadFunction	Internal class deprecated in favour of ContinuousFileMonitoringFunction.
org.apache.flink.streaming.api.functions.source.FromElementsFunction	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.FromIteratorFunction	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.FromSplittableIteratorFunction	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.InputFormatSourceFunction	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.MessageAcknowledgingSourceBase	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.MultipleIdsMessageAcknowledgingSourceBase	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.RichParallelSourceFunction	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.RichSourceFunction	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.SocketTextStreamFunction	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.source.StatefulSequenceSource	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.functions.timestamps.AscendingTimestampExtractor
org.apache.flink.streaming.api.functions.windowing.RichProcessAllWindowFunction	use ProcessAllWindowFunction instead
org.apache.flink.streaming.api.functions.windowing.RichProcessWindowFunction	use ProcessWindowFunction instead
org.apache.flink.streaming.api.operators.co.LegacyKeyedCoProcessOperator	Replaced by KeyedCoProcessOperator which takes KeyedCoProcessFunction
org.apache.flink.streaming.api.operators.LegacyKeyedProcessOperator	Replaced by KeyedProcessOperator which takes KeyedProcessFunction
org.apache.flink.streaming.api.operators.StreamSource	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.api.operators.StreamSourceContexts	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.runtime.tasks.SourceStreamTask	This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
org.apache.flink.streaming.runtime.tasks.StreamTaskActionExecutor.SynchronizedStreamTaskActionExecutor	this class should only be used in SourceStreamTask which exposes the checkpoint lock as part of Public API.
org.apache.flink.streaming.util.serialization.AbstractDeserializationSchema	Use AbstractDeserializationSchema instead.
org.apache.flink.streaming.util.serialization.SimpleStringSchema	Use SimpleStringSchema instead.
org.apache.flink.streaming.util.serialization.TypeInformationSerializationSchema	Use TypeInformationSerializationSchema instead.

Enums

Enum

Description

org.apache.flink.streaming.api.TimeCharacteristic

In Flink 1.12 the default stream time characteristic has been changed to TimeCharacteristic.EventTime, thus you don't need to call this method for enabling event-time support anymore. Explicitly using processing-time windows and timers works in event-time mode. If you need to disable watermarks, please use ExecutionConfig.setAutoWatermarkInterval(long). If you are using TimeCharacteristic.IngestionTime, please manually set an appropriate WatermarkStrategy. If you are using generic "time window" operations (for example KeyedStream.timeWindow(org.apache.flink.streaming.api.windowing.time.Time) that change behaviour based on the time characteristic, please use equivalent operations that explicitly specify processing time or event time.

Fields

Field	Description
org.apache.flink.streaming.api.environment.CheckpointConfig.DEFAULT_CHECKPOINT_ID_OF_IGNORED_IN_FLIGHT_DATA	This field is no longer used. Please use ExecutionCheckpointingOptions.CHECKPOINT_ID_OF_IGNORED_IN_FLIGHT_DATA instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.DEFAULT_MAX_CONCURRENT_CHECKPOINTS	This field is no longer used. Please use ExecutionCheckpointingOptions.MAX_CONCURRENT_CHECKPOINTS instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.DEFAULT_MIN_PAUSE_BETWEEN_CHECKPOINTS	This field is no longer used. Please use ExecutionCheckpointingOptions.MIN_PAUSE_BETWEEN_CHECKPOINTS instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.DEFAULT_MODE
org.apache.flink.streaming.api.environment.CheckpointConfig.DEFAULT_TIMEOUT	This field is no longer used. Please use ExecutionCheckpointingOptions.CHECKPOINTING_TIMEOUT instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.UNDEFINED_TOLERABLE_CHECKPOINT_NUMBER	This field is no longer used.
org.apache.flink.streaming.api.environment.ExecutionCheckpointingOptions.ALIGNMENT_TIMEOUT	Use ExecutionCheckpointingOptions.ALIGNED_CHECKPOINT_TIMEOUT instead.
org.apache.flink.streaming.api.environment.ExecutionCheckpointingOptions.FORCE_CHECKPOINTING	This will be removed once iterations properly participate in checkpointing.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.DEFAULT_JOB_NAME	This constant does not fit well to batch runtime mode.

Methods

Method	Description
org.apache.flink.streaming.api.datastream.AllWindowedStream.apply(ReduceFunction<T>, AllWindowFunction<T, R, W>)	Use AllWindowedStream.reduce(ReduceFunction, AllWindowFunction) instead.
org.apache.flink.streaming.api.datastream.CoGroupedStreams.WithWindow.with(CoGroupFunction<T1, T2, T>)	This method will be removed once the CoGroupedStreams.WithWindow.apply(CoGroupFunction) method is fixed in the next major version of Flink (2.0).
org.apache.flink.streaming.api.datastream.DataStream.assignTimestampsAndWatermarks(AssignerWithPeriodicWatermarks<T>)	Please use DataStream.assignTimestampsAndWatermarks(WatermarkStrategy) instead.
org.apache.flink.streaming.api.datastream.DataStream.keyBy(int...)	Use DataStream.keyBy(KeySelector).
org.apache.flink.streaming.api.datastream.DataStream.partitionCustom(Partitioner<K>, int)	use DataStream.partitionCustom(Partitioner, KeySelector).
org.apache.flink.streaming.api.datastream.DataStream.timeWindowAll(Time)	Please use DataStream.windowAll(WindowAssigner) with either TumblingEventTimeWindows or TumblingProcessingTimeWindows. For more information, see the deprecation notice on TimeCharacteristic
org.apache.flink.streaming.api.datastream.DataStream.writeAsCsv(String)	Please use the StreamingFileSink explicitly using the DataStream.addSink(SinkFunction) method.
org.apache.flink.streaming.api.datastream.DataStream.writeAsText(String)	Please use the StreamingFileSink explicitly using the DataStream.addSink(SinkFunction) method.
org.apache.flink.streaming.api.datastream.DataStream.writeUsingOutputFormat(OutputFormat<T>)	Please use the StreamingFileSink explicitly using the DataStream.addSink(SinkFunction) method.
org.apache.flink.streaming.api.datastream.DataStreamUtils.collect(DataStream<OUT>)	Please use DataStream.executeAndCollect().
org.apache.flink.streaming.api.datastream.DataStreamUtils.collectBoundedStream(DataStream<E>, String)	Please use DataStream.executeAndCollect().
org.apache.flink.streaming.api.datastream.DataStreamUtils.collectRecordsFromUnboundedStream(ClientAndIterator<E>, int)	Please use DataStream.executeAndCollect().
org.apache.flink.streaming.api.datastream.DataStreamUtils.collectUnboundedStream(DataStream<E>, int, String)	Please use DataStream.executeAndCollect().
org.apache.flink.streaming.api.datastream.DataStreamUtils.collectWithClient(DataStream<OUT>, String)	Please use DataStream.executeAndCollect().
org.apache.flink.streaming.api.datastream.JoinedStreams.WithWindow.with(JoinFunction<T1, T2, T>)	This method will be removed once the JoinedStreams.WithWindow.apply(JoinFunction) method is fixed in the next major version of Flink (2.0).
org.apache.flink.streaming.api.datastream.KeyedStream.asQueryableState(String)	The Queryable State feature is deprecated since Flink 1.18, and will be removed in a future Flink major version.
org.apache.flink.streaming.api.datastream.KeyedStream.process(ProcessFunction<T, R>)	Use KeyedStream.process(KeyedProcessFunction)
org.apache.flink.streaming.api.datastream.KeyedStream.timeWindow(Time)	Please use KeyedStream.window(WindowAssigner) with either TumblingEventTimeWindows or TumblingProcessingTimeWindows. For more information, see the deprecation notice on TimeCharacteristic
org.apache.flink.streaming.api.datastream.WindowedStream.apply(ReduceFunction<T>, WindowFunction<T, R, K, W>)	Use WindowedStream.reduce(ReduceFunction, WindowFunction) instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.enableExternalizedCheckpoints(CheckpointConfig.ExternalizedCheckpointCleanup)	use CheckpointConfig.setExternalizedCheckpointCleanup(ExternalizedCheckpointCleanup) instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.getAlignmentTimeout()	User CheckpointConfig.getAlignedCheckpointTimeout() instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.isFailOnCheckpointingErrors()	Use CheckpointConfig.getTolerableCheckpointFailureNumber().
org.apache.flink.streaming.api.environment.CheckpointConfig.isForceCheckpointing()	This will be removed once iterations properly participate in checkpointing.
org.apache.flink.streaming.api.environment.CheckpointConfig.setAlignmentTimeout(Duration)	Use CheckpointConfig.setAlignedCheckpointTimeout(Duration) instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.setFailOnCheckpointingErrors(boolean)	Use CheckpointConfig.setTolerableCheckpointFailureNumber(int).
org.apache.flink.streaming.api.environment.CheckpointConfig.setForceCheckpointing(boolean)	This will be removed once iterations properly participate in checkpointing.
org.apache.flink.streaming.api.environment.RemoteStreamEnvironment.getClientConfiguration()	This method is going to be removed in the next releases.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.addSource(SourceFunction<OUT>)	This method relies on the SourceFunction API, which is due to be removed. Use the StreamExecutionEnvironment.fromSource(Source, WatermarkStrategy, String) method based on the new Source API instead.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.enableCheckpointing(long, CheckpointingMode, boolean)	Use StreamExecutionEnvironment.enableCheckpointing(long, CheckpointingMode) instead. Forcing checkpoints will be removed in the future.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.generateSequence(long, long)	Use StreamExecutionEnvironment.fromSequence(long, long) instead to create a new data stream that contains NumberSequenceSource.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.getNumberOfExecutionRetries()	This method will be replaced by StreamExecutionEnvironment.getRestartStrategy().
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.getStreamTimeCharacteristic()	See StreamExecutionEnvironment.setStreamTimeCharacteristic(TimeCharacteristic) for deprecation notice.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.isForceCheckpointing()	Forcing checkpoints will be removed in future version.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.readFile(FileInputFormat<OUT>, String)	Use FileSource#forRecordStreamFormat()/forBulkFileFormat()/forRecordFileFormat() instead. An example of reading a file using a simple TextLineInputFormat: FileSource<String> source = FileSource.forRecordStreamFormat( new TextLineInputFormat(), new Path("/foo/bar")) .build();
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.readFileStream(String, long, FileMonitoringFunction.WatchType)	Use StreamExecutionEnvironment.readFile(FileInputFormat, String, FileProcessingMode, long) instead.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.readTextFile(String)	Use FileSource#forRecordStreamFormat()/forBulkFileFormat()/forRecordFileFormat() instead. An example of reading a file using a simple TextLineInputFormat: FileSource<String> source = FileSource.forRecordStreamFormat( new TextLineInputFormat(), new Path("/foo/bar")) .build();
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.setNumberOfExecutionRetries(int)	This method will be replaced by StreamExecutionEnvironment.setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration). The RestartStrategies.fixedDelayRestart(int, Time) contains the number of execution retries.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.setStreamTimeCharacteristic(TimeCharacteristic)	In Flink 1.12 the default stream time characteristic has been changed to TimeCharacteristic.EventTime, thus you don't need to call this method for enabling event-time support anymore. Explicitly using processing-time windows and timers works in event-time mode. If you need to disable watermarks, please use ExecutionConfig.setAutoWatermarkInterval(long). If you are using TimeCharacteristic.IngestionTime, please manually set an appropriate WatermarkStrategy. If you are using generic "time window" operations (for example KeyedStream.timeWindow(org.apache.flink.streaming.api.windowing.time.Time) that change behaviour based on the time characteristic, please use equivalent operations that explicitly specify processing time or event time.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.socketTextStream(String, int, char, long)	Use StreamExecutionEnvironment.socketTextStream(String, int, String, long) instead.
org.apache.flink.streaming.api.functions.sink.SinkFunction.invoke(IN)	Use SinkFunction.invoke(Object, Context).
org.apache.flink.streaming.api.graph.StreamConfig.getTypeSerializerIn1(ClassLoader)
org.apache.flink.streaming.api.graph.StreamConfig.getTypeSerializerIn2(ClassLoader)
org.apache.flink.streaming.api.graph.StreamGraph.getStreamEdgesOrThrow(int, int)
org.apache.flink.streaming.api.operators.AbstractStreamOperator.setProcessingTimeService(ProcessingTimeService)	The ProcessingTimeService instance should be passed by the operator constructor and this method will be removed along with SetupableStreamOperator.
org.apache.flink.streaming.api.windowing.triggers.Trigger.TriggerContext.getKeyValueState(String, Class<S>, S)	Use Trigger.TriggerContext.getPartitionedState(StateDescriptor).