Package io.camunda.zeebe.snapshots.impl

Class FileBasedTransientSnapshot

java.lang.Object

io.camunda.zeebe.snapshots.impl.FileBasedTransientSnapshot

All Implemented Interfaces:

PersistableSnapshot, TransientSnapshot

public final class FileBasedTransientSnapshot
extends Object
implements TransientSnapshot

Represents a pending snapshot, that is a snapshot in the process of being written and has not yet been committed to the store.

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()
ActorFuture<Void>	take(Consumer<Path> takeSnapshot)	Takes a snapshot on the given path.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

take

public ActorFuture<Void> take(Consumer<Path> takeSnapshot)

Description copied from interface: TransientSnapshot

Takes a snapshot on the given path. This can be persisted later via calling PersistableSnapshot.persist(). Based on the implementation this could mean that this is writen before on a temporary folder and then moved to the valid snapshot directory.

Specified by:

take in interface TransientSnapshot

Parameters:

takeSnapshot - the predicate which should take the snapshot and should return true on success

Returns:

true on success, false otherwise

abort

public ActorFuture<Void> abort()

Description copied from interface: PersistableSnapshot

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

Specified by:

abort in interface PersistableSnapshot

Returns:

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

persist

public ActorFuture<PersistedSnapshot> persist()

Description copied from interface: PersistableSnapshot

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

Specified by:

persist in interface PersistableSnapshot

Returns:

a future that will be completed with the persisted snapshot

snapshotId

public SnapshotId snapshotId()

Specified by:

snapshotId in interface PersistableSnapshot

Returns:

the snapshotId of the snapshot

getPath

public Path getPath()

Description copied from interface: PersistableSnapshot

Returns the pending snapshot's path.

Specified by:

getPath in interface PersistableSnapshot

Returns:

the path of the pending snapshot

toString

public String toString()

Overrides:

toString in class Object