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.

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

Constructor Summary

Constructors

Constructor and Description
CheckpointOptions(CheckpointType checkpointType, CheckpointStorageLocationReference targetLocation)
CheckpointOptions(CheckpointType checkpointType, CheckpointStorageLocationReference targetLocation, boolean isExactlyOnceMode, boolean isUnalignedCheckpoint)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static CheckpointOptions	forCheckpointWithDefaultLocation()
static CheckpointOptions	forCheckpointWithDefaultLocation(boolean isExactlyOnceMode, boolean isUnalignedCheckpoint)
CheckpointType	getCheckpointType() Returns the type of checkpoint to perform.
CheckpointStorageLocationReference	getTargetLocation() Returns the target location for the checkpoint.
int	hashCode()
boolean	isExactlyOnceMode()
boolean	isUnalignedCheckpoint()
boolean	needsAlignment()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckpointOptions

@VisibleForTesting
public CheckpointOptions(CheckpointType checkpointType,
                                            CheckpointStorageLocationReference targetLocation)

CheckpointOptions

public CheckpointOptions(CheckpointType checkpointType,
                         CheckpointStorageLocationReference targetLocation,
                         boolean isExactlyOnceMode,
                         boolean isUnalignedCheckpoint)

Method Detail

needsAlignment

public boolean needsAlignment()

getCheckpointType

public CheckpointType 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()

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()

forCheckpointWithDefaultLocation

public static CheckpointOptions forCheckpointWithDefaultLocation(boolean isExactlyOnceMode,
                                                                 boolean isUnalignedCheckpoint)