org.apache.flink.runtime.checkpoint.savepoint

Interface Savepoint

All Superinterfaces:

org.apache.flink.util.Disposable, org.apache.flink.core.io.Versioned

All Known Implementing Classes:

SavepointV1, SavepointV2

public interface Savepoint
extends org.apache.flink.util.Disposable, org.apache.flink.core.io.Versioned

Savepoints are manually-triggered snapshots from which a program can be resumed on submission.

In order to allow changes to the savepoint format between Flink versions, we allow different savepoint implementations (see subclasses of this interface).

Savepoints are serialized via a SavepointSerializer.

Method Summary

Modifier and Type	Method and Description
long	getCheckpointId() Returns the checkpoint ID of the savepoint.
Collection<MasterState>	getMasterStates() Gets the checkpointed states generated by the master.
Collection<OperatorState>	getOperatorStates() Returns the snapshotted operator states.
Collection<TaskState>	getTaskStates() Deprecated. Only kept for backwards-compatibility with versionS < 1.3. Will be removed in the future.

Methods inherited from interface org.apache.flink.util.Disposable

dispose

Methods inherited from interface org.apache.flink.core.io.Versioned

getVersion

Method Detail

getCheckpointId

long getCheckpointId()

Returns the checkpoint ID of the savepoint.

Savepoints use the same mechanisms as regular checkpoints and are identified by a unique ID. This ID is used to reset the CheckpointIDCounter when restoring from a savepoint.

Returns:

Checkpoint ID of the savepoint

getTaskStates

@Deprecated
Collection<TaskState> getTaskStates()

Deprecated. Only kept for backwards-compatibility with versionS < 1.3. Will be removed in the future.

Returns the snapshotted task states.

These are used to restore the snapshot state.

Returns:

Snapshotted task states

getMasterStates

Collection<MasterState> getMasterStates()

Gets the checkpointed states generated by the master.

getOperatorStates

Collection<OperatorState> getOperatorStates()

Returns the snapshotted operator states.

These are used to restore the snapshot state.

Returns:

Snapshotted operator states