org.apache.flink.statefun.sdk.state

Class Expiration

java.lang.Object

org.apache.flink.statefun.sdk.state.Expiration

All Implemented Interfaces:

java.io.Serializable

public final class Expiration
extends java.lang.Object
implements java.io.Serializable

State Expiration Configuration

This class defines the way state can be auto expired by the runtime. State expiration (also known as state TTL) can be used to keep state from growing arbitrarily by assigning an expiration date to a PersistedAppendingBuffer, PersistedValue or a PersistedTable.

State can be expired after a duration had passed since either from the last write to the state, or the last read.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Expiration.Mode

Constructor Summary

Constructors

Constructor and Description
Expiration(Expiration.Mode mode, java.time.Duration duration)

Method Summary

Modifier and Type	Method and Description
java.time.Duration	duration()
static Expiration	expireAfter(java.time.Duration duration, Expiration.Mode mode)
static Expiration	expireAfterReadingOrWriting(java.time.Duration duration) Returns an Expiration configuration that would expire a @duration after the last write or read.
static Expiration	expireAfterWriting(java.time.Duration duration) Returns an Expiration configuration that would expire a @duration after the last write.
Expiration.Mode	mode()
static Expiration	none()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Expiration

@ForRuntime
public Expiration(Expiration.Mode mode,
                              java.time.Duration duration)

Method Detail

expireAfterWriting

public static Expiration expireAfterWriting(java.time.Duration duration)

Returns an Expiration configuration that would expire a @duration after the last write.

Parameters:

duration - a duration to wait before considering the state expired.

expireAfterReadingOrWriting

public static Expiration expireAfterReadingOrWriting(java.time.Duration duration)

Returns an Expiration configuration that would expire a @duration after the last write or read.

Parameters:

duration - a duration to wait before considering the state expired.

expireAfter

public static Expiration expireAfter(java.time.Duration duration,
                                     Expiration.Mode mode)

none

public static Expiration none()

Returns:

Returns a disabled expiration

mode

public Expiration.Mode mode()

duration

public java.time.Duration duration()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object