org.apache.samza.checkpoint

Interface CheckpointManager

public interface CheckpointManager

CheckpointManagers read and write Checkpoint to some implementation-specific location.

Method Summary

Modifier and Type	Method and Description
default void	clearCheckpoints() Clear the checkpoints in the checkpoint stream.
default void	createResources() Creates checkpoint stream.
Checkpoint	readLastCheckpoint(TaskName taskName) Returns the last recorded checkpoint for a specified taskName.
void	register(TaskName taskName) Registers this manager to write checkpoints of a specific Samza stream partition.
void	start() Perform startup operations.
void	stop() Perform teardown operations for the Manager.
void	writeCheckpoint(TaskName taskName, Checkpoint checkpoint) Writes a checkpoint based on the current state of a Samza stream partition.

Method Detail

createResources

default void createResources()

Creates checkpoint stream.

start

void start()

Perform startup operations.

register

void register(TaskName taskName)

Registers this manager to write checkpoints of a specific Samza stream partition.

Parameters:

taskName - Specific Samza taskName of which to write checkpoints for.

writeCheckpoint

void writeCheckpoint(TaskName taskName,
                     Checkpoint checkpoint)

Writes a checkpoint based on the current state of a Samza stream partition.

Parameters:

taskName - Specific Samza taskName of which to write a checkpoint of.

checkpoint - Reference to a Checkpoint object to store offset data in.

readLastCheckpoint

Checkpoint readLastCheckpoint(TaskName taskName)

Returns the last recorded checkpoint for a specified taskName.

Parameters:

taskName - Specific Samza taskName for which to get the last checkpoint of.

Returns:

A Checkpoint object with the recorded offset data of the specified partition or null if there is no recorded checkpoints for the task.

stop

void stop()

Perform teardown operations for the Manager. Checkpoints are still persisted.

clearCheckpoints

default void clearCheckpoints()

Clear the checkpoints in the checkpoint stream.