org.apache.flink.state.api.functions

Class StateBootstrapFunction<IN>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.state.api.functions.StateBootstrapFunction<IN>

Type Parameters:

IN - The type of the input.

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.streaming.api.checkpoint.CheckpointedFunction

@PublicEvolving
public abstract class StateBootstrapFunction<IN>
extends org.apache.flink.api.common.functions.AbstractRichFunction
implements org.apache.flink.streaming.api.checkpoint.CheckpointedFunction

Interface for writing elements to operator state.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StateBootstrapFunction.Context Context that StateBootstrapFunction's can use for getting additional data about an input record.

Constructor Summary

Constructors

Constructor and Description
StateBootstrapFunction()

Method Summary

Modifier and Type	Method and Description
abstract void	processElement(IN value, StateBootstrapFunction.Context ctx) Writes the given value to operator state.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.streaming.api.checkpoint.CheckpointedFunction

initializeState, snapshotState

Constructor Detail

StateBootstrapFunction

public StateBootstrapFunction()

Method Detail

processElement

public abstract void processElement(IN value,
                                    StateBootstrapFunction.Context ctx)
                             throws Exception

Writes the given value to operator state. This function is called for every record.

Parameters:

value - The input record.

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.