Packages

final class EventEnvelope[Event] extends AnyRef

Event wrapper adding meta data for the events in the result stream of akka.persistence.query.typed.scaladsl.EventsBySliceQuery query, or similar queries.

If the event is not defined it has not been loaded yet. It can be loaded with akka.persistence.query.typed.scaladsl.LoadEventQuery.

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

It is an improved EventEnvelope compared to akka.persistence.query.EventEnvelope.

Source
EventEnvelope.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventEnvelope
  2. AnyRef
  3. 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

Instance Constructors

  1. new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, eventOption: Option[Event], timestamp: Long, eventMetadata: Option[Any], entityType: String, slice: Int)
  2. new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, eventOption: Option[Event], timestamp: Long, eventMetadata: Option[Any], entityType: String, slice: Int, filtered: Boolean, source: String)
  3. new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, eventOption: Option[Event], timestamp: Long, eventMetadata: Option[Any], entityType: String, slice: Int, filtered: Boolean, source: String, tags: Set[String])

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 EventEnvelope[Event] toany2stringadd[EventEnvelope[Event]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EventEnvelope[Event], B)
    Implicit
    This member is added by an implicit conversion from EventEnvelope[Event] toArrowAssoc[EventEnvelope[Event]] 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: (EventEnvelope[Event]) => Boolean, msg: => Any): EventEnvelope[Event]
    Implicit
    This member is added by an implicit conversion from EventEnvelope[Event] toEnsuring[EventEnvelope[Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (EventEnvelope[Event]) => Boolean): EventEnvelope[Event]
    Implicit
    This member is added by an implicit conversion from EventEnvelope[Event] toEnsuring[EventEnvelope[Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): EventEnvelope[Event]
    Implicit
    This member is added by an implicit conversion from EventEnvelope[Event] toEnsuring[EventEnvelope[Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): EventEnvelope[Event]
    Implicit
    This member is added by an implicit conversion from EventEnvelope[Event] toEnsuring[EventEnvelope[Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. val entityType: String
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(obj: Any): Boolean
    Definition Classes
    EventEnvelope → AnyRef → Any
  15. def event: Event
  16. val eventMetadata: Option[Any]
  17. val eventOption: Option[Event]
  18. val filtered: Boolean
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def getEvent(): Event

    Java API

  21. def getEventMetaData(): Optional[AnyRef]

    Java API

  22. def getOptionalEvent(): Optional[Event]

    Java API

  23. def getTags(): Set[String]

    Java API:

  24. def hashCode(): Int
    Definition Classes
    EventEnvelope → AnyRef → Any
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  29. val offset: Offset
  30. val persistenceId: String
  31. val sequenceNr: Long
  32. val slice: Int
  33. val source: String
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. val tags: Set[String]
  36. val timestamp: Long
  37. def toString(): String
    Definition Classes
    EventEnvelope → AnyRef → Any
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. def withEvent(event: Event): EventEnvelope[Event]
  42. def withEventOption(eventOption: Option[Event]): EventEnvelope[Event]
  43. def withMetadata(metadata: Any): EventEnvelope[Event]
  44. def withPersistenceId(persistenceId: String, entityType: String, slice: Int): EventEnvelope[Event]

    entityType and slice should be derived from the persistenceId, but must be explicitly defined when changing the persistenceId of the envelope.

    entityType and slice should be derived from the persistenceId, but must be explicitly defined when changing the persistenceId of the envelope. The slice should be calculated with akka.persistence.Persistence.sliceForPersistenceId for the given persistenceId. The entityType should be extracted from the persistenceId with akka.persistence.typed.PersistenceId.extractEntityType.

  45. def withTags(tags: Set[String]): EventEnvelope[Event]

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 EventEnvelope[Event] toStringFormat[EventEnvelope[Event]] 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): (EventEnvelope[Event], B)
    Implicit
    This member is added by an implicit conversion from EventEnvelope[Event] toArrowAssoc[EventEnvelope[Event]] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEventEnvelope[Event] to any2stringadd[EventEnvelope[Event]]

Inherited by implicit conversion StringFormat fromEventEnvelope[Event] to StringFormat[EventEnvelope[Event]]

Inherited by implicit conversion Ensuring fromEventEnvelope[Event] to Ensuring[EventEnvelope[Event]]

Inherited by implicit conversion ArrowAssoc fromEventEnvelope[Event] to ArrowAssoc[EventEnvelope[Event]]

Ungrouped