akka.persistence

Recover

Related Docs: object Recover | package persistence

case class Recover(fromSnapshot: SnapshotSelectionCriteria = SnapshotSelectionCriteria.Latest, toSequenceNr: Long = Long.MaxValue, replayMax: Long = Long.MaxValue) extends Product with Serializable

Instructs a persistent actor to recover itself. 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 journaled messages.

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
Recovery.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Recover
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Recover(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.

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Recover to any2stringadd[Recover] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Recover, B)

    Implicit information
    This member is added by an implicit conversion from Recover to ArrowAssoc[Recover] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (Recover) ⇒ Boolean, msg: ⇒ Any): Recover

    Implicit information
    This member is added by an implicit conversion from Recover to Ensuring[Recover] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (Recover) ⇒ Boolean): Recover

    Implicit information
    This member is added by an implicit conversion from Recover to Ensuring[Recover] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): Recover

    Implicit information
    This member is added by an implicit conversion from Recover to Ensuring[Recover] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): Recover

    Implicit information
    This member is added by an implicit conversion from Recover to Ensuring[Recover] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Recover to StringFormat[Recover] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  15. val fromSnapshot: SnapshotSelectionCriteria

    criteria for selecting a saved snapshot from which recovery should start.

    criteria for selecting a saved snapshot from which recovery should start. Default is latest (= youngest) snapshot.

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. val replayMax: Long

    maximum number of messages to replay.

    maximum number of messages to replay. Default is no limit.

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  23. val toSequenceNr: Long

    upper sequence number bound (inclusive) for recovery.

    upper sequence number bound (inclusive) for recovery. Default is no upper bound.

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. def →[B](y: B): (Recover, B)

    Implicit information
    This member is added by an implicit conversion from Recover to ArrowAssoc[Recover] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Recover to any2stringadd[Recover]

Inherited by implicit conversion StringFormat from Recover to StringFormat[Recover]

Inherited by implicit conversion Ensuring from Recover to Ensuring[Recover]

Inherited by implicit conversion ArrowAssoc from Recover to ArrowAssoc[Recover]

Ungrouped