Package org.apache.flink.fnexecution.v1

Enum FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType

java.lang.Object

java.lang.Enum<FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType>

org.apache.flink.fnexecution.v1.FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType>

Enclosing class:

FlinkFnApi.StateDescriptor.StateTTLConfig

public static enum FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType
extends Enum<FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType>
implements com.google.protobuf.ProtocolMessageEnum

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

Protobuf enum org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.UpdateType

Enum Constant Summary

Enum Constants

Enum Constant	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.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	Disabled_VALUE	TTL is disabled.
static int	OnCreateAndWrite_VALUE	Last access timestamp is initialised when state is created and updated on every write operation.
static int	OnReadAndWrite_VALUE	The same as OnCreateAndWrite but also updated on read.

Method Summary

Modifier and Type	Method	Description
static FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType>	internalGetValueMap()
static FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType	valueOf(int value)	Deprecated.
static FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FlinkFnApi.StateDescriptor.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 FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType Disabled

 TTL is disabled. State does not expire.
 

Disabled = 0;

OnCreateAndWrite

public static final FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType OnCreateAndWrite

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

OnCreateAndWrite = 1;

OnReadAndWrite

public static final FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType OnReadAndWrite

 The same as OnCreateAndWrite but also updated on read.
 

OnReadAndWrite = 2;

UNRECOGNIZED

public static final FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType UNRECOGNIZED

Field Detail

Disabled_VALUE

public static final int Disabled_VALUE

 TTL is disabled. State does not expire.
 

Disabled = 0;

See Also:

Constant Field Values

OnCreateAndWrite_VALUE

public static final int OnCreateAndWrite_VALUE

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

OnCreateAndWrite = 1;

See Also:

Constant Field Values

OnReadAndWrite_VALUE

public static final int OnReadAndWrite_VALUE

 The same as OnCreateAndWrite but also updated on read.
 

OnReadAndWrite = 2;

See Also:

Constant Field Values

Method Detail

values

public static FlinkFnApi.StateDescriptor.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 (FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType c : FlinkFnApi.StateDescriptor.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 FlinkFnApi.StateDescriptor.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

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType valueOf(int value)

Deprecated.

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:

value - 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

forNumber

public static FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)

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:

desc - 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