org.apache.flink.state.api

Class WritableSavepoint<F extends WritableSavepoint>

java.lang.Object

org.apache.flink.state.api.WritableSavepoint<F>

Type Parameters:

F - The implementation type.

Direct Known Subclasses:

ExistingSavepoint, NewSavepoint

@PublicEvolving
public abstract class WritableSavepoint<F extends WritableSavepoint>
extends Object

A WritableSavepoint is any savepoint that can be written to from a batch context. Internally, a SavepointMetadata object is maintained that keeps track of the set of existing operator states in the savepoint, as well as newly added operator states defined by their BootstrapTransformation.

Field Summary

Fields

Modifier and Type	Field and Description
protected SavepointMetadata	metadata The savepoint metadata, which maintains the current set of existing / newly added operator states.
protected org.apache.flink.runtime.state.StateBackend	stateBackend The state backend to use when writing this savepoint.

Method Summary

Modifier and Type	Method and Description
F	removeOperator(String uid) Drop an existing operator from the savepoint.
<T> F	withOperator(String uid, BootstrapTransformation<T> transformation) Adds a new operator to the savepoint.
void	write(String path) Write out a new or updated savepoint.

Methods inherited from class java.lang.Object

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

Field Detail

metadata

protected final SavepointMetadata metadata

The savepoint metadata, which maintains the current set of existing / newly added operator states.

stateBackend

protected final org.apache.flink.runtime.state.StateBackend stateBackend

The state backend to use when writing this savepoint.

Method Detail

removeOperator

public F removeOperator(String uid)

Drop an existing operator from the savepoint.

Parameters:

uid - The uid of the operator.

Returns:

A modified savepoint.

withOperator

public <T> F withOperator(String uid,
                          BootstrapTransformation<T> transformation)

Adds a new operator to the savepoint.

Parameters:

uid - The uid of the operator.

transformation - The operator to be included.

Returns:

The modified savepoint.

write

public final void write(String path)

Write out a new or updated savepoint.

Parameters:

path - The path to where the savepoint should be written.