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

Class StateTtlConfig

java.lang.Object

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

All Implemented Interfaces:

Serializable

@PublicEvolving
public class StateTtlConfig
extends Object
implements Serializable

Configuration of state TTL logic.

Note: The map state with TTL currently supports null user values only if the user value serializer can handle null values. If the serializer does not support null values, it can be wrapped with NullableSerializer at the cost of an extra byte in the serialized form.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StateTtlConfig.Builder	Builder for the StateTtlConfig.
static class	StateTtlConfig.CleanupStrategies	TTL cleanup strategies.
static class	StateTtlConfig.IncrementalCleanupStrategy	Configuration of cleanup strategy while taking the full snapshot.
static class	StateTtlConfig.RocksdbCompactFilterCleanupStrategy	Configuration of cleanup strategy using custom compaction filter in RocksDB.
static class	StateTtlConfig.StateVisibility	This option configures whether expired user value can be returned or not.
static class	StateTtlConfig.TtlTimeCharacteristic	This option configures time scale to use for ttl.
static class	StateTtlConfig.UpdateType	This option value configures when to update last access timestamp which prolongs state TTL.

Field Summary

Fields

Modifier and Type	Field	Description
static StateTtlConfig	DISABLED

Method Summary

Modifier and Type	Method	Description
StateTtlConfig.CleanupStrategies	getCleanupStrategies()
StateTtlConfig.StateVisibility	getStateVisibility()
java.time.Duration	getTimeToLive()
Time	getTtl()	Deprecated. Use getTimeToLive()
StateTtlConfig.TtlTimeCharacteristic	getTtlTimeCharacteristic()
StateTtlConfig.UpdateType	getUpdateType()
boolean	isEnabled()
static StateTtlConfig.Builder	newBuilder(java.time.Duration ttl)
static StateTtlConfig.Builder	newBuilder(Time ttl)	Deprecated. Use newBuilder(Duration)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DISABLED

public static final StateTtlConfig DISABLED

Method Detail

getUpdateType

@Nonnull
public StateTtlConfig.UpdateType getUpdateType()

getStateVisibility

@Nonnull
public StateTtlConfig.StateVisibility getStateVisibility()

getTtl

@Deprecated
@Nonnull
public Time getTtl()

Deprecated.

Use getTimeToLive()

getTimeToLive

public java.time.Duration getTimeToLive()

getTtlTimeCharacteristic

@Nonnull
public StateTtlConfig.TtlTimeCharacteristic getTtlTimeCharacteristic()

isEnabled

public boolean isEnabled()

getCleanupStrategies

@Nonnull
public StateTtlConfig.CleanupStrategies getCleanupStrategies()

toString

public String toString()

Overrides:

toString in class Object

newBuilder

@Deprecated
@Nonnull
public static StateTtlConfig.Builder newBuilder(@Nonnull
                                                Time ttl)

Deprecated.

Use newBuilder(Duration)

newBuilder

public static StateTtlConfig.Builder newBuilder(java.time.Duration ttl)