final case class Recovery(fromSnapshot: SnapshotSelectionCriteria = SnapshotSelectionCriteria.Latest, toSequenceNr: Long = Long.MaxValue, replayMax: Long = Long.MaxValue) extends Product with Serializable
Recovery mode configuration object to be returned in PersistentActor#recovery.
By default recovers from latest snapshot replays through to the last available event (last sequenceId).
Recovery will start from a snapshot if the persistent actor has previously saved one or more snapshots
and at least one of these snapshots matches the specified fromSnapshot criteria.
Otherwise, recovery will start from scratch by replaying all stored events.
If recovery starts from a snapshot, the persistent actor is offered that snapshot with a SnapshotOffer
message, followed by replayed messages, if any, that are younger than the snapshot, up to the
specified upper sequence number bound (toSequenceNr).
- fromSnapshot
criteria for selecting a saved snapshot from which recovery should start. Default is latest (= youngest) snapshot.
- toSequenceNr
upper sequence number bound (inclusive) for recovery. Default is no upper bound.
- replayMax
maximum number of messages to replay. Default is no limit.
- Annotations
- @SerialVersionUID()
- Source
- PersistentActor.scala
- Alphabetic
- By Inheritance
- Recovery
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Recovery(fromSnapshot: SnapshotSelectionCriteria = SnapshotSelectionCriteria.Latest, toSequenceNr: Long = Long.MaxValue, replayMax: Long = Long.MaxValue)
- fromSnapshot
criteria for selecting a saved snapshot from which recovery should start. Default is latest (= youngest) snapshot.
- toSequenceNr
upper sequence number bound (inclusive) for recovery. Default is no upper bound.
- replayMax
maximum number of messages to replay. Default is no limit.