org.apache.flink.api.common.state

Enum StateTtlConfig.UpdateType

java.lang.Object

java.lang.Enum<StateTtlConfig.UpdateType>

org.apache.flink.api.common.state.StateTtlConfig.UpdateType

All Implemented Interfaces:

Serializable, Comparable<StateTtlConfig.UpdateType>

Enclosing class:

StateTtlConfig

@PublicEvolving
public static enum StateTtlConfig.UpdateType
extends Enum<StateTtlConfig.UpdateType>

This option value configures when to update last access timestamp which prolongs state TTL.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Disabled TTL is disabled.
OnCreateAndWrite Last access timestamp is initialised when state is created and updated on every write operation.
OnReadAndWrite The same as OnCreateAndWrite but also updated on read.

Method Summary

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

Disabled

public static final StateTtlConfig.UpdateType Disabled

TTL is disabled. State does not expire.

OnCreateAndWrite

public static final StateTtlConfig.UpdateType OnCreateAndWrite

Last access timestamp is initialised when state is created and updated on every write operation.

OnReadAndWrite

public static final StateTtlConfig.UpdateType OnReadAndWrite

The same as OnCreateAndWrite but also updated on read.

Method Detail

values

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

Returns:

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

valueOf

public static StateTtlConfig.UpdateType 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