Packages

trait PersistentRepr extends Message

Plugin API: representation of a persistent message in the journal plugin API.

Annotations
@DoNotInherit()
Source
Persistent.scala
See also

akka.persistence.journal.AsyncWriteJournal

akka.persistence.journal.AsyncRecovery

Linear Supertypes
Message, Serializable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PersistentRepr
  2. Message
  3. Serializable
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def deleted: Boolean

    Not used, can always be false.

    Not used, can always be false.

    Not used in new records stored with Akka v2.4, but old records from v2.3 may have this as true if it was a non-permanent delete.

  2. abstract def manifest: String

    Returns the event adapter manifest for the persistent payload (event) if available May be "" if event adapter manifest is not used.

    Returns the event adapter manifest for the persistent payload (event) if available May be "" if event adapter manifest is not used. Note that this is not the same as the manifest of the serialized representation of the payload.

  3. abstract def metadata: Option[Any]
  4. abstract def payload: Any

    This persistent message's payload (the event).

  5. abstract def persistenceId: String

    Persistent id that journals a persistent message

  6. abstract def sender: ActorRef

    Not used, can be null

  7. abstract def sequenceNr: Long

    This persistent message's sequence number.

  8. abstract def timestamp: Long

    The timestamp is the time the event was stored, in milliseconds since midnight, January 1, 1970 UTC (same as System.currentTimeMillis).

    The timestamp is the time the event was stored, in milliseconds since midnight, January 1, 1970 UTC (same as System.currentTimeMillis).

    Value 0 is used if undefined.

  9. abstract def update(sequenceNr: Long = sequenceNr, persistenceId: String = persistenceId, deleted: Boolean = deleted, sender: ActorRef = sender, writerUuid: String = writerUuid): PersistentRepr

    Creates a new copy of this PersistentRepr.

  10. abstract def withManifest(manifest: String): PersistentRepr

    Creates a new persistent message with the specified event adapter manifest.

  11. abstract def withMetadata(metadata: Any): PersistentRepr
  12. abstract def withPayload(payload: Any): PersistentRepr

    Creates a new persistent message with the specified payload (event).

  13. abstract def withTimestamp(newTimestamp: Long): PersistentRepr
  14. abstract def writerUuid: String

    Unique identifier of the writing persistent actor.

    Unique identifier of the writing persistent actor. Used to detect anomalies with overlapping writes from multiple persistent actors, which can result in inconsistent replays.

Concrete 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
    This member is added by an implicit conversion from PersistentRepr toany2stringadd[PersistentRepr] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PersistentRepr, B)
    Implicit
    This member is added by an implicit conversion from PersistentRepr toArrowAssoc[PersistentRepr] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (PersistentRepr) => Boolean, msg: => Any): PersistentRepr
    Implicit
    This member is added by an implicit conversion from PersistentRepr toEnsuring[PersistentRepr] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (PersistentRepr) => Boolean): PersistentRepr
    Implicit
    This member is added by an implicit conversion from PersistentRepr toEnsuring[PersistentRepr] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): PersistentRepr
    Implicit
    This member is added by an implicit conversion from PersistentRepr toEnsuring[PersistentRepr] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): PersistentRepr
    Implicit
    This member is added by an implicit conversion from PersistentRepr toEnsuring[PersistentRepr] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PersistentRepr toStringFormat[PersistentRepr] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (PersistentRepr, B)
    Implicit
    This member is added by an implicit conversion from PersistentRepr toArrowAssoc[PersistentRepr] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Message

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromPersistentRepr to any2stringadd[PersistentRepr]

Inherited by implicit conversion StringFormat fromPersistentRepr to StringFormat[PersistentRepr]

Inherited by implicit conversion Ensuring fromPersistentRepr to Ensuring[PersistentRepr]

Inherited by implicit conversion ArrowAssoc fromPersistentRepr to ArrowAssoc[PersistentRepr]

Ungrouped