Package org.apache.flink.core.execution

Enum SavepointFormatType

java.lang.Object

java.lang.Enum<SavepointFormatType>

org.apache.flink.core.execution.SavepointFormatType

All Implemented Interfaces:

Serializable, Comparable<SavepointFormatType>, DescribedEnum

@PublicEvolving
public enum SavepointFormatType
extends Enum<SavepointFormatType>
implements DescribedEnum

Describes the binary format in which a savepoint should be taken.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANONICAL	A canonical, common for all state backends format.
NATIVE	A format specific for the chosen state backend, in its native binary format.

Field Summary

Fields

Modifier and Type	Field	Description
static SavepointFormatType	DEFAULT

Method Summary

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

CANONICAL

public static final SavepointFormatType CANONICAL

A canonical, common for all state backends format. It lets users switch state backends.

NATIVE

public static final SavepointFormatType NATIVE

A format specific for the chosen state backend, in its native binary format. Might be faster to take and restore from than the canonical one.

Field Detail

DEFAULT

public static final SavepointFormatType DEFAULT

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

@Internal
public InlineElement getDescription()

Description copied from interface: DescribedEnum

Returns the description for the enum constant.

If you want to include links or code blocks, use TextElement.wrap(InlineElement...) to wrap multiple inline elements into a single one.

Specified by:

getDescription in interface DescribedEnum