final class EventEnvelope extends Product4[Offset, String, Long, Any] with Serializable
Event wrapper adding meta data for the events in the result stream of akka.persistence.query.scaladsl.EventsByTagQuery query, or similar queries.
The timestamp
is the time the event was stored, in milliseconds since midnight, January 1, 1970 UTC
(same as System.currentTimeMillis
).
- Source
- EventEnvelope.scala
- Alphabetic
- By Inheritance
- EventEnvelope
- Serializable
- Product4
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, event: Any, timestamp: Long)
- new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, event: Any, timestamp: Long, _eventMetadata: Option[Any])
- new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, event: Any)
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.2) for binary compatibility
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 toany2stringadd[EventEnvelope] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EventEnvelope, B)
- Implicit
- This member is added by an implicit conversion from EventEnvelope toArrowAssoc[EventEnvelope] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def _1: Offset
- Definition Classes
- EventEnvelope → Product4
- def _2: String
- Definition Classes
- EventEnvelope → Product4
- def _3: Long
- Definition Classes
- EventEnvelope → Product4
- def _4: Any
- Definition Classes
- EventEnvelope → Product4
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def canEqual(that: Any): Boolean
- Definition Classes
- EventEnvelope → Equals
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def copy(offset: Offset = this.offset, persistenceId: String = this.persistenceId, sequenceNr: Long = this.sequenceNr, event: Any = this.event): EventEnvelope
- def ensuring(cond: (EventEnvelope) => Boolean, msg: => Any): EventEnvelope
- Implicit
- This member is added by an implicit conversion from EventEnvelope toEnsuring[EventEnvelope] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EventEnvelope) => Boolean): EventEnvelope
- Implicit
- This member is added by an implicit conversion from EventEnvelope toEnsuring[EventEnvelope] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EventEnvelope
- Implicit
- This member is added by an implicit conversion from EventEnvelope toEnsuring[EventEnvelope] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EventEnvelope
- Implicit
- This member is added by an implicit conversion from EventEnvelope toEnsuring[EventEnvelope] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
- Definition Classes
- EventEnvelope → Equals → AnyRef → Any
- val event: Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getMetadata[M](metadataType: Class[M]): Optional[M]
Java API: The metadata of a given type that is associated with the event.
- def hashCode(): Int
- Definition Classes
- EventEnvelope → AnyRef → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def metadata[M](implicit arg0: ClassTag[M]): Option[M]
Scala API: The metadata of a given type that is associated with the event.
- 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
- def productArity: Int
- Definition Classes
- Product4 → Product
- def productElement(n: Int): Any
- Definition Classes
- Product4 → Product
- Annotations
- @throws(classOf[java.lang.IndexOutOfBoundsException])
- def productElementName(n: Int): String
- Definition Classes
- Product
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def productPrefix: String
- Definition Classes
- EventEnvelope → Product
- val sequenceNr: Long
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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])
Deprecated Value Members
- def eventMetadata: Option[Any]
Scala API
Scala API
- Annotations
- @deprecated
- Deprecated
Use metadata with metadataType parameter
- 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 toStringFormat[EventEnvelope] 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,formatted
resolves to the new method in String which has reversed parameters.
- def getEventMetaData(): Optional[AnyRef]
Java API
Java API
- Annotations
- @deprecated
- Deprecated
Use getMetadata with metadataType parameter
- def →[B](y: B): (EventEnvelope, B)
- Implicit
- This member is added by an implicit conversion from EventEnvelope toArrowAssoc[EventEnvelope] 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.