org.apache.flink.runtime.checkpoint.savepoint

Class SavepointV2

java.lang.Object

org.apache.flink.runtime.checkpoint.savepoint.SavepointV2

All Implemented Interfaces:

Versioned, Savepoint, Disposable

public class SavepointV2
extends Object
implements Savepoint

The persistent checkpoint metadata, format version 2. This format was introduced with Flink 1.3.0.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION The savepoint version.

Constructor Summary

Constructors

Constructor and Description
SavepointV2(long checkpointId, Collection<OperatorState> operatorStates, Collection<MasterState> masterStates)
SavepointV2(long checkpointId, Collection<TaskState> taskStates) Deprecated. Only kept for backwards-compatibility with versions < 1.3. Will be removed in the future.

Method Summary

Modifier and Type	Method and Description
static Savepoint	convertToOperatorStateSavepointV2(Map<JobVertexID,ExecutionJobVertex> tasks, Savepoint savepoint) Deprecated. Only kept for backwards-compatibility with versions < 1.3. Will be removed in the future.
void	dispose() Disposes the object and releases all resources.
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() Returns the snapshotted task states.
int	getVersion() Returns the version number of the object.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VERSION

public static final int VERSION

The savepoint version.

See Also:

Constant Field Values

Constructor Detail

SavepointV2

@Deprecated
public SavepointV2(long checkpointId,
                               Collection<TaskState> taskStates)

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

SavepointV2

public SavepointV2(long checkpointId,
                   Collection<OperatorState> operatorStates,
                   Collection<MasterState> masterStates)

Method Detail

getVersion

public int getVersion()

Description copied from interface: Versioned

Returns the version number of the object. Versions numbers can be used to differentiate evolving classes.

Specified by:

getVersion in interface Versioned

getCheckpointId

public long getCheckpointId()

Description copied from interface: Savepoint

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.

Specified by:

getCheckpointId in interface Savepoint

Returns:

Checkpoint ID of the savepoint

getOperatorStates

public Collection<OperatorState> getOperatorStates()

Description copied from interface: Savepoint

Returns the snapshotted operator states.

These are used to restore the snapshot state.

Specified by:

getOperatorStates in interface Savepoint

Returns:

Snapshotted operator states

getTaskStates

public Collection<TaskState> getTaskStates()

Description copied from interface: Savepoint

Returns the snapshotted task states.

These are used to restore the snapshot state.

Specified by:

getTaskStates in interface Savepoint

Returns:

Snapshotted task states

getMasterStates

public Collection<MasterState> getMasterStates()

Description copied from interface: Savepoint

Gets the checkpointed states generated by the master.

Specified by:

getMasterStates in interface Savepoint

dispose

public void dispose()
             throws Exception

Description copied from interface: Disposable

Disposes the object and releases all resources. After calling this method, calling any methods on the object may result in undefined behavior.

Specified by:

dispose in interface Disposable

Throws:

Exception - if something goes wrong during disposal.

toString

public String toString()

Overrides:

toString in class Object

convertToOperatorStateSavepointV2

@Deprecated
public static Savepoint convertToOperatorStateSavepointV2(Map<JobVertexID,ExecutionJobVertex> tasks,
                                                                      Savepoint savepoint)

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

Converts the Savepoint containing TaskStates to an equivalent savepoint containing OperatorStates.

Parameters:

savepoint - savepoint to convert

tasks - map of all vertices and their job vertex ids

Returns:

converted completed checkpoint