Package io.camunda.zeebe.snapshots.impl

Class FileBasedReceivedSnapshot

java.lang.Object

io.camunda.zeebe.snapshots.impl.FileBasedReceivedSnapshot

All Implemented Interfaces:

PersistableSnapshot, ReceivedSnapshot

public class FileBasedReceivedSnapshot
extends Object
implements ReceivedSnapshot

Method Summary

Modifier and Type	Method	Description
ActorFuture<Void>	abort()	Aborts the not yet persisted snapshot and removes all related data.
ActorFuture<Void>	apply(SnapshotChunk snapshotChunk)	Applies the next SnapshotChunk to the snapshot.
Path	getPath()	Returns the pending snapshot's path.
long	index()	The index of the current receiving snapshot.
ActorFuture<PersistedSnapshot>	persist()	Persists the snapshot with all his data and returns the representation of this snapshot.
SnapshotId	snapshotId()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

index

public long index()

Description copied from interface: ReceivedSnapshot

The index of the current receiving snapshot.

Specified by:

index in interface ReceivedSnapshot

Returns:

the snapshot's index

apply

public ActorFuture<Void> apply(SnapshotChunk snapshotChunk)

Description copied from interface: ReceivedSnapshot

Applies the next SnapshotChunk to the snapshot. Based on the implementation the chunk can be validated before applied to the snapshot. In case of failure, the future will be completed with a SnapshotWriteException.

Specified by:

apply in interface ReceivedSnapshot

Parameters:

snapshotChunk - the SnapshotChunk which should be applied

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