Deprecated API

Contents

• Interfaces
• Classes
• Enums
• Methods
• Constructors
• Enum Constants

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.sink.legacy.SinkFunction	This interface will be removed in future versions. Use the new Sink interface instead.
org.apache.flink.streaming.api.functions.source.legacy.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.legacy.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.operators.legacy.YieldingOperatorFactory

Classes

Class	Description
org.apache.flink.runtime.checkpoint.SubtaskState	Internal class for savepoint backwards compatibility. Don't use for other purposes.
org.apache.flink.runtime.checkpoint.TaskState	Internal class for savepoint backwards compatibility. Don't use for other purposes.
org.apache.flink.runtime.rest.handler.job.metrics.JobVertexMetricsHandler	This class is subsumed by SubtaskMetricsHandler and is only kept for backwards-compatibility.
org.apache.flink.runtime.rest.messages.YarnCancelJobTerminationHeaders	This should be removed once we can send arbitrary REST calls via the Yarn proxy.
org.apache.flink.runtime.rest.messages.YarnStopJobTerminationHeaders	This should be removed once we can send arbitrary REST calls via the Yarn proxy.
org.apache.flink.runtime.state.filesystem.AbstractFileStateBackend	State backends should no longer implement CheckpointStorage functionality. Please inherit AbstractStateBackend instead. Custom checkpoint storage can be additionally implemented as a separate class.
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.sink.legacy.OutputFormatSinkFunction	Please use the StreamingFileSink for writing to files from a streaming program.
org.apache.flink.streaming.api.functions.sink.legacy.PrintSinkFunction	This interface will be removed in future versions. Use the new PrintSink interface instead.
org.apache.flink.streaming.api.functions.sink.legacy.RichSinkFunction	This interface will be removed in future versions. Use the new Sink interface instead.
org.apache.flink.streaming.api.functions.sink.legacy.SocketClientSink	This interface will be removed in future versions. Use the new Sink interface instead.
org.apache.flink.streaming.api.functions.source.legacy.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.legacy.FileMonitoringFunction	Internal class deprecated in favour of ContinuousFileMonitoringFunction.
org.apache.flink.streaming.api.functions.source.legacy.FileReadFunction	Internal class deprecated in favour of ContinuousFileMonitoringFunction.
org.apache.flink.streaming.api.functions.source.legacy.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.legacy.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.legacy.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.legacy.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.legacy.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.legacy.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.legacy.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.legacy.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.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.

Enums

Enum	Description
org.apache.flink.streaming.api.CheckpointingMode	This class has been moved to CheckpointingMode.

Methods

Method	Description
org.apache.flink.runtime.highavailability.HighAvailabilityServices.getJobManagerLeaderRetriever(JobID)	This method should only be used by the legacy code where the JobManager acts as the master.
org.apache.flink.runtime.highavailability.HighAvailabilityServices.getWebMonitorLeaderElection()	Use HighAvailabilityServices.getClusterRestEndpointLeaderElection() instead.
org.apache.flink.runtime.highavailability.HighAvailabilityServices.getWebMonitorLeaderRetriever()	just use HighAvailabilityServices.getClusterRestEndpointLeaderRetriever() instead of this method.
org.apache.flink.runtime.io.network.buffer.Buffer.getMemorySegment()
org.apache.flink.runtime.io.network.buffer.Buffer.getMemorySegmentOffset()
org.apache.flink.runtime.jobmaster.LogicalSlot.releaseSlot()	Added because extended the actual releaseSlot method with cause parameter.
org.apache.flink.runtime.operators.hash.InMemoryPartition.overwriteRecordAt(long, T)	Don't use this, overwrites record and causes inconsistency or data loss for overwriting everything but records of the exact same size
org.apache.flink.streaming.api.connector.sink2.CommittableSummary.getNumberOfPendingCommittables()
org.apache.flink.streaming.api.datastream.ConnectedStreams.keyBy(int, int)	use ConnectedStreams.keyBy(KeySelector, KeySelector)
org.apache.flink.streaming.api.datastream.DataStream.writeUsingOutputFormat(OutputFormat<T>)	Please use the org.apache.flink.streaming.api.functions.sink.filesystem.legacy.StreamingFileSink explicitly using the DataStream.addSink(SinkFunction) method.
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.environment.CheckpointConfig.getCheckpointingMode()	Use CheckpointConfig.getCheckpointingConsistencyMode() instead.
org.apache.flink.streaming.api.environment.CheckpointConfig.setCheckpointingMode(CheckpointingMode)	Use CheckpointConfig.setCheckpointingConsistencyMode(org.apache.flink.core.execution.CheckpointingMode) instead.
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)	use StreamExecutionEnvironment.enableCheckpointing(long, CheckpointingMode) instead.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.fromCollection(Collection<OUT>)	This method will be removed a future release, possibly as early as version 2.0. Use StreamExecutionEnvironment.fromData(Collection) instead.
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment.fromElements(OUT...)	This method will be removed a future release, possibly as early as version 2.0. Use #fromData(OUT...) instead.
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.getCheckpointingMode()	Use StreamExecutionEnvironment.getCheckpointingConsistencyMode() instead.
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.socketTextStream(String, int, char, long)	Use StreamExecutionEnvironment.socketTextStream(String, int, String, long) instead.
org.apache.flink.streaming.api.functions.sink.legacy.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)

Constructors

Constructor	Description
org.apache.flink.runtime.jobgraph.tasks.CheckpointCoordinatorConfiguration(long, long, long, int, CheckpointRetentionPolicy, boolean, boolean, int, long)	use CheckpointCoordinatorConfiguration.builder().
org.apache.flink.runtime.leaderretrieval.StandaloneLeaderRetrievalService(String)	Use StandaloneLeaderRetrievalService(String, UUID) instead
org.apache.flink.streaming.api.connector.sink2.CommittableSummary(int, int, long, int, int, int)

Enum Constants

Enum Constant	Description
org.apache.flink.runtime.rest.messages.TerminationModeQueryParameter.TerminationMode.STOP	Please use the "stop" command instead.