Package io.camunda.zeebe.snapshots

Interface ConstructableSnapshotStore

All Superinterfaces:

AutoCloseable, BootstrapSnapshotStore, CloseableSilently, PersistedSnapshotStore

All Known Implementing Classes:

FileBasedSnapshotStore

public interface ConstructableSnapshotStore
extends PersistedSnapshotStore

A persisted snapshot store than can create a new snapshot and persists it.

Method Summary

Modifier and Type	Method	Description
Either<SnapshotException,TransientSnapshot>	newTransientSnapshot(long index, long term, long processedPosition, long exportedPosition, boolean forceSnapshot)	Starts a new transient snapshot which can be persisted after the snapshot was taken.

Methods inherited from interface io.camunda.zeebe.snapshots.BootstrapSnapshotStore

copyForBootstrap, deleteBootstrapSnapshots, getBootstrapSnapshot

Methods inherited from interface io.camunda.zeebe.util.CloseableSilently

close

Methods inherited from interface io.camunda.zeebe.snapshots.PersistedSnapshotStore

abortPendingSnapshots, addSnapshotListener, delete, getAvailableSnapshots, getCompactionBound, getCurrentSnapshotIndex, getLatestSnapshot, getPath, hasSnapshotId, removeSnapshotListener

Method Details

newTransientSnapshot

Either<SnapshotException,TransientSnapshot> newTransientSnapshot(long index,
 long term,
 long processedPosition,
 long exportedPosition,
 boolean forceSnapshot)

Starts a new transient snapshot which can be persisted after the snapshot was taken.

Parameters:

index - the index to which the snapshot corresponds to

term - the term to which the snapshots corresponds to

processedPosition - the processed position in the snapshot

exportedPosition - the exported position in the snapshot

Returns:

either an exception or transientSnapshot, if it was taken successfully.