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
- Alphabetic
- By Inheritance
Inherited
- EventEnvelope
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, eventOption: Option[Event], timestamp: Long, eventMetadata: Option[Any], entityType: String, slice: Int)
- new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, eventOption: Option[Event], timestamp: Long, eventMetadata: Option[Any], entityType: String, slice: Int, filtered: Boolean, source: String)
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- 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
- 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
- val entityType: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
- Definition Classes
- EventEnvelope → AnyRef → Any
- def event: Event
- val eventMetadata: Option[Any]
- val eventOption: Option[Event]
- val filtered: Boolean
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getEvent(): Event
Java API
- def getEventMetaData(): Optional[AnyRef]
Java API
- def getOptionalEvent(): Optional[Event]
Java API
- def getTags(): Set[String]
Java API:
- def hashCode(): Int
- Definition Classes
- EventEnvelope → AnyRef → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val offset: Offset
- val persistenceId: String
- val sequenceNr: Long
- val slice: Int
- val source: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val tags: Set[String]
- val timestamp: Long
- def toString(): String
- Definition Classes
- EventEnvelope → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withEvent(event: Event): EventEnvelope[Event]
- def withEventOption(eventOption: Option[Event]): EventEnvelope[Event]
- def withMetadata(metadata: Any): EventEnvelope[Event]
- def withPersistenceId(persistenceId: String, entityType: String, slice: Int): EventEnvelope[Event]
entityTypeandsliceshould be derived from thepersistenceId, but must be explicitly defined when changing thepersistenceIdof the envelope.entityTypeandsliceshould be derived from thepersistenceId, but must be explicitly defined when changing thepersistenceIdof the envelope. Thesliceshould be calculated with akka.persistence.Persistence.sliceForPersistenceId for the givenpersistenceId. TheentityTypeshould be extracted from thepersistenceIdwithakka.persistence.typed.PersistenceId.extractEntityType. - def withTags(tags: Set[String]): EventEnvelope[Event]
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.