Interface ISnapshotter

Snapshot API on top of the internal snapshot protocol.

Namespace: Akka.Persistence
Assembly: Akka.Persistence.dll
Syntax
public interface ISnapshotter

Properties

| Edit this page View Source

SnapshotSequenceNr

Incrementable sequence number to use when taking a snapshot.

Declaration
long SnapshotSequenceNr { get; }
Property Value
Type Description
long
| Edit this page View Source

SnapshotterId

Snapshotter id.

Declaration
string SnapshotterId { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

DeleteSnapshot(long)

Deletes the snapshot identified by sequenceNr.

The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotSuccess or DeleteSnapshotFailure message.

Declaration
void DeleteSnapshot(long sequenceNr)
Parameters
Type Name Description
long sequenceNr

TBD
| Edit this page View Source

DeleteSnapshots(SnapshotSelectionCriteria)

Deletes all snapshots matching criteria.

The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotsSuccess or DeleteSnapshotsFailure message.

Declaration
void DeleteSnapshots(SnapshotSelectionCriteria criteria)
Parameters
Type Name Description
SnapshotSelectionCriteria criteria

TBD
| Edit this page View Source

LoadSnapshot(string, SnapshotSelectionCriteria, long)

Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

Declaration
void LoadSnapshot(string persistenceId, SnapshotSelectionCriteria criteria, long toSequenceNr)
Parameters
Type Name Description
string persistenceId

TBD
SnapshotSelectionCriteria criteria

TBD
long toSequenceNr

TBD
| Edit this page View Source

SaveSnapshot(object)

Saves snapshot of current ISnapshotter state.

The PersistentActor will be notified about the success or failure of this via an SaveSnapshotSuccess or SaveSnapshotFailure message.

Declaration
void SaveSnapshot(object snapshot)
Parameters
Type Name Description
object snapshot

TBD

Extension Methods