org.apache.flink.statefun.flink.state.processor

Class StatefulFunctionsSavepointCreator

java.lang.Object

org.apache.flink.statefun.flink.state.processor.StatefulFunctionsSavepointCreator

public class StatefulFunctionsSavepointCreator
extends java.lang.Object

Entry point for generating a new savepoint for a Stateful Functions application.

Users register multiple StateBootstrapFunctions that each define how to bootstrap a given stateful function, as well as provide Flink DataSets that contain data that serve as input for the bootstrap functions. The StatefulFunctionsSavepointCreator can then be used to construct a Flink batch job which writes out a savepoint that contains the bootstrapped state and may be used to restore a Stateful Functions application.

Constructor Summary

Constructors

Constructor and Description
StatefulFunctionsSavepointCreator(int maxParallelism) Creates a StatefulFunctionsSavepointCreator.

Method Summary

Modifier and Type	Method and Description
<IN> StatefulFunctionsSavepointCreator	withBootstrapData(org.apache.flink.api.java.DataSet<IN> bootstrapDataset, BootstrapDataRouterProvider<IN> routerProvider) Registers a Flink DataSet to be used as inputs to StateBootstrapFunctions for bootstrapping state.
StatefulFunctionsSavepointCreator	withFsStateBackend() Use Flink's FsStateBackend to generate the savepoint.
StatefulFunctionsSavepointCreator	withStateBootstrapFunctionProvider(FunctionType functionType, StateBootstrapFunctionProvider bootstrapFunctionProvider) Registers a StateBootstrapFunctionProvider to the savepoint creator.
void	write(java.lang.String path) Writes the constructed savepoint to a given path.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatefulFunctionsSavepointCreator

public StatefulFunctionsSavepointCreator(int maxParallelism)

Creates a StatefulFunctionsSavepointCreator.

Parameters:

maxParallelism - max parallelism of the Stateful Functions application to be restored using the generated savepoint.

Method Detail

withFsStateBackend

public StatefulFunctionsSavepointCreator withFsStateBackend()

Use Flink's FsStateBackend to generate the savepoint. By default, RocksDBStateBackend is used.

This affects the format of the generated savepoint, and should therefore be the same as what is configured by the Stateful Functions application to be restored using the generated savepoint.

Returns:

the savepoint creator, configured to use the FsStateBackend.

withBootstrapData

public <IN> StatefulFunctionsSavepointCreator withBootstrapData(org.apache.flink.api.java.DataSet<IN> bootstrapDataset,
                                                                BootstrapDataRouterProvider<IN> routerProvider)

Registers a Flink DataSet to be used as inputs to StateBootstrapFunctions for bootstrapping state. A provider for a Router that addresses each element in the bootstrap dataset to StateBootstrapFunction instances must also be defined.

For all bootstrap functions that may receive a state bootstrap input, a StateBootstrapFunctionProvider must also be registered for it using withStateBootstrapFunctionProvider(FunctionType, StateBootstrapFunctionProvider).

Type Parameters:

IN - data type of the input bootstrap dataset

Parameters:

bootstrapDataset - a Flink DataSet containing inputs for bootstrapping state.

routerProvider - provider of a Router that addresses each element in the bootstrap dataset to StateBootstrapFunction instances.

Returns:

the savepoint creator, configured to use the given bootstrap data

withStateBootstrapFunctionProvider

public StatefulFunctionsSavepointCreator withStateBootstrapFunctionProvider(FunctionType functionType,
                                                                            StateBootstrapFunctionProvider bootstrapFunctionProvider)

Registers a StateBootstrapFunctionProvider to the savepoint creator.

Parameters:

functionType - the type of function that is being bootstrapped.

bootstrapFunctionProvider - the bootstrap function provider to register.

Returns:

the savepoint creator, configured to use the given StateBootstrapFunctionProvider.

write

public void write(java.lang.String path)

Writes the constructed savepoint to a given path.

Parameters:

path - path to write the generated savepoint to.