StateTtlConfig.StateVisibility (Flink : 2.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<StateTtlConfig.StateVisibility>
- - org.apache.flink.api.common.state.StateTtlConfig.StateVisibility

All Implemented Interfaces:

Serializable, Comparable<StateTtlConfig.StateVisibility>

Enclosing class:

StateTtlConfig
```
@PublicEvolving
public static enum StateTtlConfig.StateVisibility
extends Enum<StateTtlConfig.StateVisibility>
```
This option configures whether expired user value can be returned or not.

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.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static StateTtlConfig.StateVisibility`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static 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 StateTtlConfig.StateVisibility ReturnExpiredIfNotCleanedUp
```
    Return expired user value if it is not cleaned up yet.
  - NeverReturnExpired
```
public static final StateTtlConfig.StateVisibility NeverReturnExpired
```
    Never return expired user value.
- Method Detail
  - values
```
public static 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 (StateTtlConfig.StateVisibility c : 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 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