org.apache.flink.runtime.checkpoint

Enum CheckpointRetentionPolicy

java.lang.Object

java.lang.Enum<CheckpointRetentionPolicy>

org.apache.flink.runtime.checkpoint.CheckpointRetentionPolicy

All Implemented Interfaces:

Serializable, Comparable<CheckpointRetentionPolicy>

@Internal
public enum CheckpointRetentionPolicy
extends Enum<CheckpointRetentionPolicy>

Policy for whether checkpoints are retained after a job terminates.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEVER_RETAIN_AFTER_TERMINATION Checkpoints should always be cleaned up when an application reaches a terminal state.
RETAIN_ON_CANCELLATION Checkpoints should be retained on cancellation and failure.
RETAIN_ON_FAILURE Checkpoints should be retained on failure, but not on cancellation.

Method Summary

Modifier and Type	Method and Description
static CheckpointRetentionPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static CheckpointRetentionPolicy[]	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

RETAIN_ON_CANCELLATION

public static final CheckpointRetentionPolicy RETAIN_ON_CANCELLATION

Checkpoints should be retained on cancellation and failure.

RETAIN_ON_FAILURE

public static final CheckpointRetentionPolicy RETAIN_ON_FAILURE

Checkpoints should be retained on failure, but not on cancellation.

NEVER_RETAIN_AFTER_TERMINATION

public static final CheckpointRetentionPolicy NEVER_RETAIN_AFTER_TERMINATION

Checkpoints should always be cleaned up when an application reaches a terminal state.

Method Detail

values

public static CheckpointRetentionPolicy[] 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 (CheckpointRetentionPolicy c : CheckpointRetentionPolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static CheckpointRetentionPolicy 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