Snapshotter

All Superinterfaces:

Actor

All Known Subinterfaces:

AbstractPersistentActorLike, AtLeastOnceDelivery, AtLeastOnceDeliveryLike, Eventsourced, PersistentActor, PersistentFSM<S,D,E>

All Known Implementing Classes:

AbstractPersistentActor, AbstractPersistentActorWithAtLeastOnceDelivery, AbstractPersistentActorWithTimers, AbstractPersistentFSM, AbstractPersistentLoggingFSM, JournalPerfSpec.BenchActor, PersistentShardCoordinator
```
public interface Snapshotter
extends Actor
```
Snapshot API on top of the internal snapshot protocol.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.pekko.actor.Actor
  Actor.emptyBehavior$, Actor.ignoringBehavior$

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`deleteSnapshot(long sequenceNr)`	Deletes the snapshot identified by `sequenceNr`.
`void`	`deleteSnapshots(SnapshotSelectionCriteria criteria)`	Deletes all snapshots matching `criteria`.
`void`	`loadSnapshot(java.lang.String persistenceId, SnapshotSelectionCriteria criteria, long toSequenceNr)`	Instructs the snapshot store to load the specified snapshot and send it via an `SnapshotOffer` to the running `PersistentActor`.
`void`	`saveSnapshot(java.lang.Object snapshot)`	Saves a `snapshot` of this snapshotter's state.
`long`	`snapshotSequenceNr()`	Sequence number to use when taking a snapshot.
`ActorRef`	`snapshotStore()`	Snapshot store plugin actor.
`java.lang.String`	`snapshotterId()`	Snapshotter id.

Methods inherited from interface org.apache.pekko.actor.Actor
aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, org$apache$pekko$actor$Actor$_setter_$context_$eq, org$apache$pekko$actor$Actor$_setter_$self_$eq, postRestart, postStop, preRestart, preStart, receive, self, sender, supervisorStrategy, unhandled

- Method Detail
  - deleteSnapshot
```
void deleteSnapshot(long sequenceNr)
```
    Deletes the snapshot identified by sequenceNr.
    The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotSuccess or DeleteSnapshotFailure message.
  - deleteSnapshots
```
void deleteSnapshots(SnapshotSelectionCriteria criteria)
```
    Deletes all snapshots matching criteria.
    The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotsSuccess or DeleteSnapshotsFailure message.
  - loadSnapshot
```
void loadSnapshot(java.lang.String persistenceId,
                  SnapshotSelectionCriteria criteria,
                  long toSequenceNr)
```
    Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.
  - saveSnapshot
```
void saveSnapshot(java.lang.Object snapshot)
```
    Saves a snapshot of this snapshotter's state.
    The PersistentActor will be notified about the success or failure of this via an SaveSnapshotSuccess or SaveSnapshotFailure message.
  - snapshotSequenceNr
```
long snapshotSequenceNr()
```
    Sequence number to use when taking a snapshot.
  - snapshotStore
```
ActorRef snapshotStore()
```
    Snapshot store plugin actor.
  - snapshotterId
```
java.lang.String snapshotterId()
```
    Snapshotter id.