Package org.apache.flink.streaming.api.environment

Enum CheckpointConfig.ExternalizedCheckpointCleanup

java.lang.Object

java.lang.Enum<CheckpointConfig.ExternalizedCheckpointCleanup>

org.apache.flink.streaming.api.environment.CheckpointConfig.ExternalizedCheckpointCleanup

All Implemented Interfaces:

Serializable, Comparable<CheckpointConfig.ExternalizedCheckpointCleanup>, org.apache.flink.configuration.DescribedEnum

Enclosing class:

CheckpointConfig

@PublicEvolving
public static enum CheckpointConfig.ExternalizedCheckpointCleanup
extends Enum<CheckpointConfig.ExternalizedCheckpointCleanup>
implements org.apache.flink.configuration.DescribedEnum

Cleanup behaviour for externalized checkpoints when the job is cancelled.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELETE_ON_CANCELLATION	Delete externalized checkpoints on job cancellation.
NO_EXTERNALIZED_CHECKPOINTS	Externalized checkpoints are disabled completely.
RETAIN_ON_CANCELLATION	Retain externalized checkpoints on job cancellation.

Method Summary

Modifier and Type	Method	Description
boolean	deleteOnCancellation()	Returns whether persistent checkpoints shall be discarded on cancellation of the job.
org.apache.flink.configuration.description.InlineElement	getDescription()
static CheckpointConfig.ExternalizedCheckpointCleanup	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CheckpointConfig.ExternalizedCheckpointCleanup[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DELETE_ON_CANCELLATION

public static final CheckpointConfig.ExternalizedCheckpointCleanup DELETE_ON_CANCELLATION

Delete externalized checkpoints on job cancellation.

All checkpoint state will be deleted when you cancel the owning job, both the meta data and actual program state. Therefore, you cannot resume from externalized checkpoints after the job has been cancelled.

Note that checkpoint state is always kept if the job terminates with state JobStatus.FAILED.

RETAIN_ON_CANCELLATION

public static final CheckpointConfig.ExternalizedCheckpointCleanup RETAIN_ON_CANCELLATION

Retain externalized checkpoints on job cancellation.

All checkpoint state is kept when you cancel the owning job. You have to manually delete both the checkpoint meta data and actual program state after cancelling the job.

Note that checkpoint state is always kept if the job terminates with state JobStatus.FAILED.

NO_EXTERNALIZED_CHECKPOINTS

public static final CheckpointConfig.ExternalizedCheckpointCleanup NO_EXTERNALIZED_CHECKPOINTS

Externalized checkpoints are disabled completely.

Method Detail

values

public static CheckpointConfig.ExternalizedCheckpointCleanup[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CheckpointConfig.ExternalizedCheckpointCleanup c : CheckpointConfig.ExternalizedCheckpointCleanup.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CheckpointConfig.ExternalizedCheckpointCleanup valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

deleteOnCancellation

public boolean deleteOnCancellation()

Returns whether persistent checkpoints shall be discarded on cancellation of the job.

Returns:

true if persistent checkpoints shall be discarded on cancellation of the job.

getDescription

@Internal
public org.apache.flink.configuration.description.InlineElement getDescription()

Specified by:

getDescription in interface org.apache.flink.configuration.DescribedEnum