Packages

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
Linear Supertypes
Serializable, Product4[Offset, String, Long, Any], Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventEnvelope
  2. Serializable
  3. Product4
  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
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, event: Any, timestamp: Long)
  2. new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, event: Any, timestamp: Long, _eventMetadata: Option[Any])
  3. new EventEnvelope(offset: Offset, persistenceId: String, sequenceNr: Long, event: Any)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.2) for binary compatibility

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 toany2stringadd[EventEnvelope] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def _1: Offset
    Definition Classes
    EventEnvelope → Product4
  7. def _2: String
    Definition Classes
    EventEnvelope → Product4
  8. def _3: Long
    Definition Classes
    EventEnvelope → Product4
  9. def _4: Any
    Definition Classes
    EventEnvelope → Product4
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def canEqual(that: Any): Boolean
    Definition Classes
    EventEnvelope → Equals
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  13. def copy(offset: Offset = this.offset, persistenceId: String = this.persistenceId, sequenceNr: Long = this.sequenceNr, event: Any = this.event): EventEnvelope
  14. 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
  15. 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
  16. 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
  17. 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
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(obj: Any): Boolean
    Definition Classes
    EventEnvelope → Equals → AnyRef → Any
  20. val event: Any
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def getMetadata[M](metadataType: Class[M]): Optional[M]

    Java API: The metadata of a given type that is associated with the event.

  23. def hashCode(): Int
    Definition Classes
    EventEnvelope → AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def metadata[M](implicit arg0: ClassTag[M]): Option[M]

    Scala API: The metadata of a given type that is associated with the event.

  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. def productArity: Int
    Definition Classes
    Product4 → Product
  32. def productElement(n: Int): Any
    Definition Classes
    Product4 → Product
    Annotations
    @throws(classOf[java.lang.IndexOutOfBoundsException])
  33. def productElementName(n: Int): String
    Definition Classes
    Product
  34. def productElementNames: Iterator[String]
    Definition Classes
    Product
  35. def productIterator: Iterator[Any]
    Definition Classes
    Product
  36. def productPrefix: String
    Definition Classes
    EventEnvelope → Product
  37. def removeMetadata[M](implicit classTag: ClassTag[M]): EventEnvelope

    Scala API: Drop metadata of the given type if present

  38. def removeMetadata(metadataType: Class[_]): EventEnvelope

    Java API: Drop metadata of the given type if present

  39. val sequenceNr: Long
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. val timestamp: Long
  42. def toString(): String
    Definition Classes
    EventEnvelope → AnyRef → Any
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def eventMetadata: Option[Any]

    Scala API

    Scala API

    Annotations
    @deprecated
    Deprecated

    Use metadata with metadataType parameter

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

    (Since version 9)

  3. 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 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.

  4. def getEventMetaData(): Optional[AnyRef]

    Java API

    Java API

    Annotations
    @deprecated
    Deprecated

    Use getMetadata with metadataType parameter

  5. 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.

Inherited from Serializable

Inherited from Product4[Offset, String, Long, Any]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEventEnvelope to any2stringadd[EventEnvelope]

Inherited by implicit conversion StringFormat fromEventEnvelope to StringFormat[EventEnvelope]

Inherited by implicit conversion Ensuring fromEventEnvelope to Ensuring[EventEnvelope]

Inherited by implicit conversion ArrowAssoc fromEventEnvelope to ArrowAssoc[EventEnvelope]

Ungrouped