org.apache.flink.statefun.sdk.state

Class PersistedStateRegistry

java.lang.Object

org.apache.flink.statefun.sdk.state.PersistedStateRegistry

public final class PersistedStateRegistry
extends java.lang.Object

A PersistedStateRegistry can be used to register persisted state, such as a PersistedValue or PersistedTable, etc. All state that is registered via this registry is persisted and maintained by the system for fault-tolerance.

Created state registries must be bound to the system by using the Persisted annotation. Please see the class-level Javadoc of StatefulFunction for an example on how to do that.

See Also:

StatefulFunction

Constructor Summary

Constructors

Constructor and Description
PersistedStateRegistry()

Method Summary

Modifier and Type	Method and Description
<E> void	registerAppendingBuffer(PersistedAppendingBuffer<E> bufferState) Registers a PersistedAppendingBuffer.
void	registerRemoteValue(RemotePersistedValue remoteValueState) Registers a RemotePersistedValue.
<K,V> void	registerTable(PersistedTable<K,V> tableState) Registers a PersistedTable.
<T> void	registerValue(PersistedValue<T> valueState) Registers a PersistedValue.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistedStateRegistry

public PersistedStateRegistry()

Method Detail

registerValue

public <T> void registerValue(PersistedValue<T> valueState)

Registers a PersistedValue. If a registered state already exists for the specified name of the value, the registration fails.

Type Parameters:

T - the type of the value.

Parameters:

valueState - the value state to register.

Throws:

java.lang.IllegalStateException - if a previous registration exists for the given state name.

registerTable

public <K,V> void registerTable(PersistedTable<K,V> tableState)

Registers a PersistedTable. If a registered state already exists for the specified name of the table, the registration fails.

Type Parameters:

K - the type of the keys.

V - the type of the values.

Parameters:

tableState - the table state to register.

Throws:

java.lang.IllegalStateException - if a previous registration exists for the given state name.

registerAppendingBuffer

public <E> void registerAppendingBuffer(PersistedAppendingBuffer<E> bufferState)

Registers a PersistedAppendingBuffer. If a registered state already exists for the specified name of the table, the registration fails.

Type Parameters:

E - the type of the buffer elements.

Parameters:

bufferState - the appending buffer to register.

Throws:

java.lang.IllegalStateException - if a previous registration exists for the given state name.

registerRemoteValue

@ForRuntime
public void registerRemoteValue(RemotePersistedValue remoteValueState)

Registers a RemotePersistedValue. If a registered state already exists for the specified name of the table, the registration fails.

This method is intended only for internal use by the runtime.

Parameters:

remoteValueState - the remote value to register.

Throws:

java.lang.IllegalStateException - if a previous registration exists for the given state name.