Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Interfaces

Interface and Description
org.apache.flink.runtime.state.CheckpointListener This interface has been moved to CheckpointListener. This class is kept to maintain backwards compatibility and will be removed in future releases.

Deprecated Classes

Class and Description
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.runtime.state.filesystem.FsStateBackend
org.apache.flink.runtime.entrypoint.JobClusterEntrypoint Per-job mode has been deprecated in Flink 1.15 and will be removed in the future. Please use application mode instead.
org.apache.flink.runtime.rest.messages.JobExceptionsInfo.ExecutionExceptionInfo ExecutionExceptionInfo will be replaced by JobExceptionsInfoWithHistory.ExceptionInfo as part of the effort of deprecating JobExceptionsInfo.allExceptions.
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.state.memory.MemoryStateBackend
org.apache.flink.runtime.jobgraph.SavepointConfigOptions
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.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.

Deprecated Fields

Field and Description
org.apache.flink.runtime.entrypoint.parser.CommandLineOptions.EXECUTION_MODE_OPTION exists only for compatibility with legacy mode. Remove once legacy mode and execution mode option has been removed.
org.apache.flink.runtime.rest.messages.JobConfigInfo.ExecutionConfigInfo.FIELD_NAME_EXECUTION_MODE
org.apache.flink.runtime.rest.messages.SubtasksTimesInfo.SubtaskTimeInfo.FIELD_NAME_HOST
org.apache.flink.runtime.rest.messages.job.SubtasksAllAccumulatorsInfo.SubtaskAccumulatorsInfo.FIELD_NAME_HOST
org.apache.flink.runtime.rest.messages.job.SubtaskExecutionAttemptDetailsInfo.FIELD_NAME_HOST
org.apache.flink.runtime.rest.messages.JobExceptionsInfo.ExecutionExceptionInfo.FIELD_NAME_LOCATION
org.apache.flink.runtime.rest.messages.JobExceptionsInfoWithHistory.ExceptionInfo.FIELD_NAME_LOCATION
org.apache.flink.runtime.rest.messages.taskmanager.TaskManagerMetricsInfo.FIELD_NAME_NETWORK_MEMORY_SEGMENTS_AVAILABLE
org.apache.flink.runtime.rest.messages.taskmanager.TaskManagerMetricsInfo.FIELD_NAME_NETWORK_MEMORY_SEGMENTS_TOTAL
org.apache.flink.runtime.state.StateBackendLoader.FS_STATE_BACKEND_NAME
org.apache.flink.runtime.metrics.MetricNames.FULL_RESTARTS
org.apache.flink.runtime.entrypoint.parser.CommandLineOptions.HOST_OPTION subsumed by dynamic properties
org.apache.flink.runtime.metrics.MetricNames.IO_CURRENT_INPUT_1_WATERMARK
org.apache.flink.runtime.metrics.MetricNames.IO_CURRENT_INPUT_2_WATERMARK
org.apache.flink.runtime.state.StateBackendLoader.MEMORY_STATE_BACKEND_NAME
org.apache.flink.runtime.entrypoint.parser.CommandLineOptions.REST_PORT_OPTION subsumed by dynamic properties
org.apache.flink.runtime.rest.messages.JobVertexTaskManagersInfo.TaskManagersInfo.TASK_MANAGERS_FIELD_HOST

Deprecated Methods

Method and Description
org.apache.flink.runtime.state.VoidNamespaceTypeInfo.createSerializer(ExecutionConfig)
org.apache.flink.runtime.state.filesystem.FsStateBackend.getBasePath() Deprecated in favor of FsStateBackend.getCheckpointPath().
org.apache.flink.runtime.rest.messages.job.SubtaskExecutionAttemptDetailsInfo.getHost()
org.apache.flink.runtime.rest.handler.legacy.metrics.MetricStore.getJobManager() Use semantically equivalent MetricStore.getJobManagerMetricStore().
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.rest.messages.JobExceptionsInfoWithHistory.ExceptionInfo.getLocation()
org.apache.flink.runtime.metrics.groups.FrontMetricGroup.getLogicalScope(CharacterFilter) work against the LogicalScopeProvider interface instead.
org.apache.flink.runtime.metrics.groups.FrontMetricGroup.getLogicalScope(CharacterFilter, char) work against the LogicalScopeProvider interface instead.
org.apache.flink.runtime.io.network.buffer.Buffer.getMemorySegment()
org.apache.flink.runtime.io.network.buffer.Buffer.getMemorySegmentOffset()
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.state.KeyedStateBackend.isStateImmutableInStateBackend(CheckpointType)
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.runtime.io.network.metrics.NettyShuffleMetricFactory.registerLegacyNetworkMetrics(boolean, MetricGroup, ResultPartitionWriter[], InputGate[]) should be removed in future
org.apache.flink.runtime.io.network.NettyShuffleEnvironment.registerLegacyNetworkMetrics(MetricGroup, ResultPartitionWriter[], InputGate[]) should be removed in future
org.apache.flink.runtime.jobmaster.LogicalSlot.releaseSlot() Added because extended the actual releaseSlot method with cause parameter.

Deprecated Constructors

Constructor and 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

Deprecated Enum Constants

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