Package io.camunda.zeebe.snapshots

Interface PersistableSnapshot

All Known Subinterfaces:

ReceivedSnapshot, TransientSnapshot

All Known Implementing Classes:

FileBasedReceivedSnapshot, FileBasedTransientSnapshot

public interface PersistableSnapshot

A volatile snapshot which can be persisted.

Method Summary

Modifier and Type	Method	Description
ActorFuture<Void>	abort()	Aborts the not yet persisted snapshot and removes all related data.
Path	getPath()	Returns the pending snapshot's path.
ActorFuture<PersistedSnapshot>	persist()	Persists the snapshot with all his data and returns the representation of this snapshot.
SnapshotId	snapshotId()

Method Details

abort

ActorFuture<Void> abort()

Aborts the not yet persisted snapshot and removes all related data.

Returns:

a future which will be completed when the abort is done.

persist

ActorFuture<PersistedSnapshot> persist()

Persists the snapshot with all his data and returns the representation of this snapshot.

Returns:

a future that will be completed with the persisted snapshot

snapshotId

SnapshotId snapshotId()

Returns:

the snapshotId of the snapshot

getPath

Path getPath()

Returns the pending snapshot's path.

Returns:

the path of the pending snapshot