Package org.apache.flink.runtime.checkpoint

Class CheckpointOptions

java.lang.Object

org.apache.flink.runtime.checkpoint.CheckpointOptions

All Implemented Interfaces:

Serializable

public class CheckpointOptions
extends Object
implements Serializable

Options for performing the checkpoint. Note that different barriers may have different options.

The CheckpointProperties are related and cover properties that are only relevant at the CheckpointCoordinator. These options are relevant at the AbstractInvokable instances running on task managers.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CheckpointOptions.AlignmentType	How a checkpoint should be aligned.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	NO_ALIGNED_CHECKPOINT_TIME_OUT

Constructor Summary

Constructors

Constructor	Description
CheckpointOptions(SnapshotType checkpointType, CheckpointStorageLocationReference targetLocation)
CheckpointOptions(SnapshotType checkpointType, CheckpointStorageLocationReference targetLocation, CheckpointOptions.AlignmentType alignmentType, long alignedCheckpointTimeout)

Method Summary

Modifier and Type	Method	Description
static CheckpointOptions	alignedNoTimeout(SnapshotType type, CheckpointStorageLocationReference location)
static CheckpointOptions	alignedWithTimeout(SnapshotType type, CheckpointStorageLocationReference location, long alignedCheckpointTimeout)
boolean	equals(Object obj)
static CheckpointOptions	forCheckpointWithDefaultLocation()
static CheckpointOptions	forConfig(SnapshotType checkpointType, CheckpointStorageLocationReference locationReference, boolean isExactlyOnceMode, boolean isUnalignedEnabled, long alignedCheckpointTimeout)
long	getAlignedCheckpointTimeout()
CheckpointOptions.AlignmentType	getAlignment()
SnapshotType	getCheckpointType()	Returns the type of checkpoint to perform.
CheckpointStorageLocationReference	getTargetLocation()	Returns the target location for the checkpoint.
int	hashCode()
boolean	isExactlyOnceMode()
boolean	isTimeoutable()
boolean	isUnalignedCheckpoint()
boolean	needsAlignment()
boolean	needsChannelState()
static CheckpointOptions	notExactlyOnce(SnapshotType type, CheckpointStorageLocationReference location)
String	toString()
CheckpointOptions	toUnaligned()
static CheckpointOptions	unaligned(SnapshotType type, CheckpointStorageLocationReference location)
CheckpointOptions	withUnalignedSupported()
CheckpointOptions	withUnalignedUnsupported()

Methods inherited from class java.lang.Object

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

Field Details

NO_ALIGNED_CHECKPOINT_TIME_OUT

public static final long NO_ALIGNED_CHECKPOINT_TIME_OUT

See Also:

• Constant Field Values

Constructor Details

CheckpointOptions

@VisibleForTesting
public CheckpointOptions(SnapshotType checkpointType,
 CheckpointStorageLocationReference targetLocation)

CheckpointOptions

public CheckpointOptions(SnapshotType checkpointType,
 CheckpointStorageLocationReference targetLocation,
 CheckpointOptions.AlignmentType alignmentType,
 long alignedCheckpointTimeout)

Method Details

notExactlyOnce

public static CheckpointOptions notExactlyOnce(SnapshotType type,
 CheckpointStorageLocationReference location)

alignedNoTimeout

public static CheckpointOptions alignedNoTimeout(SnapshotType type,
 CheckpointStorageLocationReference location)

unaligned

public static CheckpointOptions unaligned(SnapshotType type,
 CheckpointStorageLocationReference location)

alignedWithTimeout

public static CheckpointOptions alignedWithTimeout(SnapshotType type,
 CheckpointStorageLocationReference location,
 long alignedCheckpointTimeout)

forConfig

public static CheckpointOptions forConfig(SnapshotType checkpointType,
 CheckpointStorageLocationReference locationReference,
 boolean isExactlyOnceMode,
 boolean isUnalignedEnabled,
 long alignedCheckpointTimeout)

needsAlignment

public boolean needsAlignment()

getAlignedCheckpointTimeout

public long getAlignedCheckpointTimeout()

getAlignment

public CheckpointOptions.AlignmentType getAlignment()

isTimeoutable

public boolean isTimeoutable()

getCheckpointType

public SnapshotType getCheckpointType()

Returns the type of checkpoint to perform.

getTargetLocation

public CheckpointStorageLocationReference getTargetLocation()

Returns the target location for the checkpoint.

isExactlyOnceMode

public boolean isExactlyOnceMode()

isUnalignedCheckpoint

public boolean isUnalignedCheckpoint()

needsChannelState

public boolean needsChannelState()

withUnalignedSupported

public CheckpointOptions withUnalignedSupported()

withUnalignedUnsupported

public CheckpointOptions withUnalignedUnsupported()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

forCheckpointWithDefaultLocation

@VisibleForTesting
public static CheckpointOptions forCheckpointWithDefaultLocation()

toUnaligned

public CheckpointOptions toUnaligned()