Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods

Deprecated Interfaces

Interface and Description
org.apache.flink.streaming.api.functions.AssignerWithPeriodicWatermarks
org.apache.flink.streaming.api.functions.AssignerWithPunctuatedWatermarks
org.apache.flink.streaming.util.serialization.DeserializationSchema Use DeserializationSchema 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.util.serialization.SerializationSchema Use SerializationSchema instead.
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.api.functions.TimestampAssigner use TimestampAssigner

Deprecated Classes

Class and Description
org.apache.flink.streaming.util.serialization.AbstractDeserializationSchema Use AbstractDeserializationSchema instead.
org.apache.flink.streaming.api.functions.AscendingTimestampExtractor Extend AscendingTimestampExtractor instead.
org.apache.flink.streaming.api.functions.timestamps.AscendingTimestampExtractor
org.apache.flink.streaming.api.windowing.assigners.BaseAlignedWindowAssigner will be removed in a future version. please use other WindowAssigners listed under org.apache.flink.streaming.api.windowing.assigners.
org.apache.flink.streaming.api.datastream.CoGroupedStreams.UnionSerializerConfigSnapshot this snapshot class is no longer in use, and is maintained only for backwards compatibility. It is fully replaced by CoGroupedStreams.UnionSerializerSnapshot.
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.IngestionTimeExtractor
org.apache.flink.streaming.api.operators.co.IntervalJoinOperator.BufferSerializerConfigSnapshot this snapshot class is no longer in use, and is maintained only for backwards compatibility. It is fully replaced by IntervalJoinOperator.BufferEntrySerializerSnapshot.
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.functions.sink.OutputFormatSinkFunction Please use the StreamingFileSink for writing to files from a streaming program.
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.util.serialization.SimpleStringSchema Use SimpleStringSchema instead.
org.apache.flink.streaming.api.windowing.assigners.SlidingTimeWindows Please use SlidingEventTimeWindows.
org.apache.flink.streaming.runtime.streamrecord.StreamElementSerializer.StreamElementSerializerConfigSnapshot see StreamElementSerializer.StreamElementSerializerSnapshot.
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.api.operators.TimerSerializer.TimerSerializerConfigSnapshot this snapshot class is no longer in use, and is maintained only for backwards compatibility purposes. It is fully replaced by TimerSerializerSnapshot.
org.apache.flink.streaming.api.windowing.assigners.TumblingTimeWindows Please use TumblingEventTimeWindows.
org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction.StateSerializerConfigSnapshot this snapshot class is no longer in use, and is maintained only for backwards compatibility purposes. It is fully replaced by TwoPhaseCommitSinkFunction.StateSerializerSnapshot.
org.apache.flink.streaming.util.serialization.TypeInformationSerializationSchema Use TypeInformationSerializationSchema instead.
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.

Deprecated Enums

Enum and 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.

Deprecated Fields

Field and Description
org.apache.flink.streaming.api.environment.ExecutionCheckpointingOptions.ALIGNMENT_TIMEOUT Use ExecutionCheckpointingOptions.ALIGNED_CHECKPOINT_TIMEOUT instead.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.DEFAULT_JOB_NAME This constant does not fit well to batch runtime mode.

Deprecated Methods

Method and 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.AllWindowedStream.apply(ReduceFunction<T>, AllWindowFunction<T, R, W>, TypeInformation<R>) Use AllWindowedStream.reduce(ReduceFunction, AllWindowFunction, TypeInformation) instead.
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.datastream.WindowedStream.apply(ReduceFunction<T>, WindowFunction<T, R, K, W>, TypeInformation<R>) Use WindowedStream.reduce(ReduceFunction, WindowFunction, TypeInformation) instead.
org.apache.flink.streaming.api.datastream.DataStream.assignTimestampsAndWatermarks(AssignerWithPeriodicWatermarks<T>) Please use DataStream.assignTimestampsAndWatermarks(WatermarkStrategy) instead.
org.apache.flink.streaming.api.datastream.DataStream.assignTimestampsAndWatermarks(AssignerWithPunctuatedWatermarks<T>) Please use DataStream.assignTimestampsAndWatermarks(WatermarkStrategy) instead.
org.apache.flink.streaming.api.datastream.DataStreamUtils.collect(DataStream<OUT>) Please use DataStream.executeAndCollect().
org.apache.flink.streaming.api.datastream.DataStreamUtils.collect(DataStream<OUT>, String) 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.environment.StreamExecutionEnvironment.enableCheckpointing() Use StreamExecutionEnvironment.enableCheckpointing(long) 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.CheckpointConfig.getAlignmentTimeout() User CheckpointConfig.getAlignedCheckpointTimeout() instead.
org.apache.flink.streaming.api.environment.RemoteStreamEnvironment.getClientConfiguration() This method is going to be removed in the next releases.
org.apache.flink.streaming.api.windowing.triggers.Trigger.TriggerContext.getKeyValueState(String, Class<S>, S) Use Trigger.TriggerContext.getPartitionedState(StateDescriptor).
org.apache.flink.streaming.api.windowing.triggers.Trigger.TriggerContext.getKeyValueState(String, TypeInformation<S>, S) Use Trigger.TriggerContext.getPartitionedState(StateDescriptor).
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.getNumberOfExecutionRetries() This method will be replaced by StreamExecutionEnvironment.getRestartStrategy().
org.apache.flink.streaming.api.graph.StreamGraph.getStreamEdgesOrThrow(int, int)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.getStreamTimeCharacteristic() See StreamExecutionEnvironment.setStreamTimeCharacteristic(TimeCharacteristic) for deprecation notice.
org.apache.flink.streaming.api.graph.StreamConfig.getTypeSerializerIn1(ClassLoader)
org.apache.flink.streaming.api.graph.StreamConfig.getTypeSerializerIn2(ClassLoader)
org.apache.flink.streaming.api.functions.sink.SinkFunction.invoke(IN) Use SinkFunction.invoke(Object, Context).
org.apache.flink.streaming.api.environment.CheckpointConfig.isFailOnCheckpointingErrors() Use CheckpointConfig.getTolerableCheckpointFailureNumber().
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.isForceCheckpointing() Forcing checkpoints will be removed in future version.
org.apache.flink.streaming.api.environment.CheckpointConfig.isForceCheckpointing() This will be removed once iterations properly participate in checkpointing.
org.apache.flink.streaming.api.datastream.DataStream.keyBy(int...) Use DataStream.keyBy(KeySelector).
org.apache.flink.streaming.api.datastream.DataStream.keyBy(String...) Use DataStream.keyBy(KeySelector).
org.apache.flink.streaming.api.windowing.assigners.TumblingTimeWindows.of(Time) Please use TumblingEventTimeWindows.of(Time).
org.apache.flink.streaming.api.windowing.assigners.SlidingTimeWindows.of(Time, Time) Please use SlidingEventTimeWindows.of(Time, Time).
org.apache.flink.streaming.api.datastream.DataStream.partitionCustom(Partitioner<K>, int) use DataStream.partitionCustom(Partitioner, KeySelector).
org.apache.flink.streaming.api.datastream.DataStream.partitionCustom(Partitioner<K>, String) use DataStream.partitionCustom(Partitioner, KeySelector).
org.apache.flink.streaming.api.datastream.KeyedStream.process(ProcessFunction<T, R>) Use KeyedStream.process(KeyedProcessFunction)
org.apache.flink.streaming.api.datastream.KeyedStream.process(ProcessFunction<T, R>, TypeInformation<R>) Use KeyedStream.process(KeyedProcessFunction, TypeInformation)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.readFile(FileInputFormat<OUT>, String, FileProcessingMode, long, FilePathFilter) Use FileInputFormat.setFilesFilter(FilePathFilter) to set a filter and StreamExecutionEnvironment.readFile(FileInputFormat, String, FileProcessingMode, long)
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.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.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.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.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) Use StreamExecutionEnvironment.socketTextStream(String, int, String) instead.
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.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.KeyedStream.timeWindow(Time, Time) Please use KeyedStream.window(WindowAssigner) with either SlidingEventTimeWindows or SlidingProcessingTimeWindows. For more information, see the deprecation notice on TimeCharacteristic
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.timeWindowAll(Time, Time) Please use DataStream.windowAll(WindowAssigner) with either SlidingEventTimeWindows or SlidingProcessingTimeWindows. For more information, see the deprecation notice on TimeCharacteristic
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.CoGroupedStreams.WithWindow.with(CoGroupFunction<T1, T2, T>, TypeInformation<T>) This method will be removed once the CoGroupedStreams.WithWindow.apply(CoGroupFunction, TypeInformation) method is fixed in the next major version of Flink (2.0).
org.apache.flink.streaming.api.datastream.JoinedStreams.WithWindow.with(FlatJoinFunction<T1, T2, T>) This method will be removed once the JoinedStreams.WithWindow.apply(FlatJoinFunction) method is fixed in the next major version of Flink (2.0).
org.apache.flink.streaming.api.datastream.JoinedStreams.WithWindow.with(FlatJoinFunction<T1, T2, T>, TypeInformation<T>) This method will be replaced by JoinedStreams.WithWindow.apply(FlatJoinFunction, TypeInformation) in Flink 2.0. So use the JoinedStreams.WithWindow.apply(FlatJoinFunction, TypeInformation) in the future.
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.JoinedStreams.WithWindow.with(JoinFunction<T1, T2, T>, TypeInformation<T>) This method will be removed once the JoinedStreams.WithWindow.apply(JoinFunction, TypeInformation) method is fixed in the next major version of Flink (2.0).
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.writeAsCsv(String, FileSystem.WriteMode) Please use the StreamingFileSink explicitly using the DataStream.addSink(SinkFunction) method.
org.apache.flink.streaming.api.datastream.DataStream.writeAsCsv(String, FileSystem.WriteMode, String, 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.writeAsText(String, FileSystem.WriteMode) 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.