org.apache.flink.statefun.sdk.java

Class Expiration

java.lang.Object

org.apache.flink.statefun.sdk.java.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 value.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Expiration.Mode

Method Summary

Modifier and Type	Method and Description
java.time.Duration	duration()
static Expiration	expireAfter(java.time.Duration duration, Expiration.Mode mode) Returns an Expiration configuration that has an expiration characteristic based on the provided expire Expiration.Mode.
static Expiration	expireAfterCall(java.time.Duration duration) Returns an Expiration configuration that would expire a @duration after the last invocation of the function.
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

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.

expireAfterCall

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

Returns an Expiration configuration that would expire a @duration after the last invocation of the function.

Parameters:

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

expireAfter

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

Returns an Expiration configuration that has an expiration characteristic based on the provided expire Expiration.Mode.

Parameters:

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

mode - the expire mode.

none

public static Expiration none()

Returns:

Returns a disabled expiration

mode

public Expiration.Mode mode()

Returns:

The expire mode of this Expiration configuration.

duration

public java.time.Duration duration()

Returns:

The duration of this Expiration configuration.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object