org.apache.beam.runners.flink.translation.wrappers.streaming.state

Interface KeyGroupCheckpointedOperator

All Superinterfaces:

KeyGroupRestoringOperator

public interface KeyGroupCheckpointedOperator
extends KeyGroupRestoringOperator

This interface is used to checkpoint key-groups state.

Method Summary

Modifier and Type	Method and Description
void	snapshotKeyGroupState(int keyGroupIndex, java.io.DataOutputStream out) Snapshots the state for a given keyGroupIdx.

Methods inherited from interface org.apache.beam.runners.flink.translation.wrappers.streaming.state.KeyGroupRestoringOperator

restoreKeyGroupState

Method Detail

snapshotKeyGroupState

void snapshotKeyGroupState(int keyGroupIndex,
                           java.io.DataOutputStream out)
                    throws java.lang.Exception

Snapshots the state for a given keyGroupIdx.

AbstractStreamOperator would call this hook in AbstractStreamOperator.snapshotState() while iterating over the key groups.

Parameters:

keyGroupIndex - the id of the key-group to be put in the snapshot.

out - the stream to write to.

Throws:

java.lang.Exception