org.apache.flink.statefun.sdk.java

Class ValueSpec<T>

java.lang.Object

org.apache.flink.statefun.sdk.java.ValueSpec<T>

Type Parameters:

T - the type of the value.

public final class ValueSpec<T>
extends java.lang.Object

A ValueSpec identifies a registered persistent value of a function, which will be managed by the Stateful Functions runtime for consistency and fault-tolerance. A ValueSpec is registered for a function by configuring it on the function's assoicated StatefulFunctionSpec.

See Also:

StatefulFunctionSpec.Builder.withValueSpec(ValueSpec), AddressScopedStorage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValueSpec.Untyped

Method Summary

Modifier and Type	Method and Description
Expiration	expiration()
java.lang.String	name()
static ValueSpec.Untyped	named(java.lang.String name) Creates an ValueSpec.Untyped spec with the given name.
Type<T>	type()
TypeName	typeName()

Methods inherited from class java.lang.Object

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

Method Detail

named

public static ValueSpec.Untyped named(java.lang.String name)

Creates an ValueSpec.Untyped spec with the given name. To complete the creation of a ValueSpec, please specify the Type of the value. For example:

 final ValueSpec<Integer> intValue = ValueSpec.named("my_int_state").withIntType();
 

The specified name string must be a valid identifier conforming to the following rules:

• First character must be an alphabet letter [a-z] / [A-Z], or an underscore '_'.
• Remaining characters can be an alphabet letter [a-z] / [A-Z], a digit [0-9], or an underscore '_'.
• Must not contain any spaces.

Parameters:

name - name for the value. Please see the method Javadocs for format rules.

Returns:

an ValueSpec.Untyped spec. Specify the Type of the value to instantiate a ValueSpec.

name

public java.lang.String name()

Returns:

The name of the value.

expiration

public Expiration expiration()

Returns:

The expiration configuration of the value.

typeName

public TypeName typeName()

Returns:

The TypeName of the value's type.

type

public Type<T> type()

Returns:

The Type of the value.