Package org.apache.flink.fnexecution.v1

Enum FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

FlinkFnApi.StateDescriptor.StateTTLConfig

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

 This option configures whether expired user value can be returned or not.
 

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
NeverReturnExpired	Never return expired user value.
ReturnExpiredIfNotCleanedUp	Return expired user value if it is not cleaned up yet.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	NeverReturnExpired_VALUE	Never return expired user value.
static int	ReturnExpiredIfNotCleanedUp_VALUE	Return expired user value if it is not cleaned up yet.

Method Summary

Modifier and Type	Method	Description
static FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility	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.StateVisibility>	internalGetValueMap()
static FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility	valueOf(int value)	Deprecated.
static FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility[]	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

ReturnExpiredIfNotCleanedUp

public static final FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility ReturnExpiredIfNotCleanedUp

 Return expired user value if it is not cleaned up yet.
 

ReturnExpiredIfNotCleanedUp = 0;

NeverReturnExpired

public static final FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility NeverReturnExpired

 Never return expired user value.
 

NeverReturnExpired = 1;

UNRECOGNIZED

public static final FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility UNRECOGNIZED

Field Detail

ReturnExpiredIfNotCleanedUp_VALUE

public static final int ReturnExpiredIfNotCleanedUp_VALUE

 Return expired user value if it is not cleaned up yet.
 

ReturnExpiredIfNotCleanedUp = 0;

See Also:

Constant Field Values

NeverReturnExpired_VALUE

public static final int NeverReturnExpired_VALUE

 Never return expired user value.
 

NeverReturnExpired = 1;

See Also:

Constant Field Values

Method Detail

values

public static FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility[] 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.StateVisibility c : FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility.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.StateVisibility 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.StateVisibility 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.StateVisibility 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.StateVisibility> 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.StateVisibility 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