Package org.apache.flink.api.common.state

Enum StateDescriptor.Type

java.lang.Object

java.lang.Enum<StateDescriptor.Type>

org.apache.flink.api.common.state.StateDescriptor.Type

All Implemented Interfaces:

Serializable, Comparable<StateDescriptor.Type>

Enclosing class:

StateDescriptor<S extends State,T>

public static enum StateDescriptor.Type
extends Enum<StateDescriptor.Type>

An enumeration of the types of supported states. Used to identify the state type when writing and restoring checkpoints and savepoints.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AGGREGATING
FOLDING
LIST
MAP
REDUCING
UNKNOWN	Deprecated. Enum for migrating from old checkpoints/savepoint versions.
VALUE

Method Summary

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

UNKNOWN

@Deprecated
public static final StateDescriptor.Type UNKNOWN

Deprecated.

Enum for migrating from old checkpoints/savepoint versions.

VALUE

public static final StateDescriptor.Type VALUE

LIST

public static final StateDescriptor.Type LIST

REDUCING

public static final StateDescriptor.Type REDUCING

FOLDING

public static final StateDescriptor.Type FOLDING

AGGREGATING

public static final StateDescriptor.Type AGGREGATING

MAP

public static final StateDescriptor.Type MAP

Method Detail

values

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

Returns:

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

valueOf

public static StateDescriptor.Type 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