org.apache.flink.runtime.checkpoint

Class CheckpointProperties

java.lang.Object

org.apache.flink.runtime.checkpoint.CheckpointProperties

All Implemented Interfaces:

Serializable

public class CheckpointProperties
extends Object
implements Serializable

The configuration of a checkpoint. This describes whether

• The checkpoint is s regular checkpoint or a savepoint.
• When the checkpoint should be garbage collected.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CheckpointProperties(boolean forced, SnapshotType checkpointType, boolean discardSubsumed, boolean discardFinished, boolean discardCancelled, boolean discardFailed, boolean discardSuspended, boolean unclaimed)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static CheckpointProperties	forCheckpoint(CheckpointRetentionPolicy policy) Creates the checkpoint properties for a checkpoint.
static CheckpointProperties	forSavepoint(boolean forced, SavepointFormatType formatType) Creates the checkpoint properties for a (manually triggered) savepoint.
static CheckpointProperties	forSyncSavepoint(boolean forced, boolean terminate, SavepointFormatType formatType)
static CheckpointProperties	forUnclaimedSnapshot() Creates the checkpoint properties for a snapshot restored in RestoreMode.NO_CLAIM.
SnapshotType	getCheckpointType() Gets the type of the checkpoint (checkpoint / savepoint).
int	hashCode()
boolean	isSavepoint() Returns whether the checkpoint properties describe a standard savepoint.
boolean	isSynchronous() Returns whether the checkpoint properties describe a synchronous savepoint/checkpoint.
boolean	isUnclaimed() Returns whether the checkpoint should be restored in a RestoreMode.NO_CLAIM mode.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CheckpointProperties

public CheckpointProperties(boolean forced,
                            SnapshotType checkpointType,
                            boolean discardSubsumed,
                            boolean discardFinished,
                            boolean discardCancelled,
                            boolean discardFailed,
                            boolean discardSuspended,
                            boolean unclaimed)

Method Detail

isUnclaimed

public boolean isUnclaimed()

Returns whether the checkpoint should be restored in a RestoreMode.NO_CLAIM mode.

getCheckpointType

public SnapshotType getCheckpointType()

Gets the type of the checkpoint (checkpoint / savepoint).

isSavepoint

public boolean isSavepoint()

Returns whether the checkpoint properties describe a standard savepoint.

Returns:

true if the properties describe a savepoint, false otherwise.

isSynchronous

public boolean isSynchronous()

Returns whether the checkpoint properties describe a synchronous savepoint/checkpoint.

Returns:

true if the properties describe a synchronous operation, false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

forSavepoint

public static CheckpointProperties forSavepoint(boolean forced,
                                                SavepointFormatType formatType)

Creates the checkpoint properties for a (manually triggered) savepoint.

Savepoints are not queued due to time trigger limits. They have to be garbage collected manually.

Returns:

Checkpoint properties for a (manually triggered) savepoint.

forUnclaimedSnapshot

public static CheckpointProperties forUnclaimedSnapshot()

Creates the checkpoint properties for a snapshot restored in RestoreMode.NO_CLAIM. Those properties should not be used when triggering a checkpoint/savepoint. They're useful when restoring a CompletedCheckpointStore after a JM failover.

Returns:

Checkpoint properties for a snapshot restored in RestoreMode.NO_CLAIM.

forSyncSavepoint

public static CheckpointProperties forSyncSavepoint(boolean forced,
                                                    boolean terminate,
                                                    SavepointFormatType formatType)

forCheckpoint

public static CheckpointProperties forCheckpoint(CheckpointRetentionPolicy policy)

Creates the checkpoint properties for a checkpoint.

Checkpoints may be queued in case too many other checkpoints are currently happening. They are garbage collected automatically, except when the owning job terminates in state JobStatus.FAILED. The user is required to configure the clean up behaviour on job cancellation.

Returns:

Checkpoint properties for an external checkpoint.