EventEnvelope

org.apache.pekko.persistence.query.typed.EventEnvelope
See theEventEnvelope companion object
@ApiMayChange
final class EventEnvelope[Event](val offset: Offset, val persistenceId: String, val sequenceNr: Long, val eventOption: Option[Event], val timestamp: Long, val eventMetadata: Option[Any], val entityType: String, val slice: Int)

Event wrapper adding meta data for the events in the result stream of pekko.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 pekko.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 pekko.persistence.query.EventEnvelope.

API May Change

Attributes

Companion
object
Source
EventEnvelope.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
Source
EventEnvelope.scala
def event: Event

Attributes

Source
EventEnvelope.scala
def getEvent(): Event

Java API

Java API

Attributes

Source
EventEnvelope.scala
def getEventMetaData(): Optional[AnyRef]

Java API

Java API

Attributes

Source
EventEnvelope.scala
def getOptionalEvent(): Optional[Event]

Java API

Java API

Attributes

Source
EventEnvelope.scala
override def hashCode(): Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
Source
EventEnvelope.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
EventEnvelope.scala

Concrete fields

Attributes

Source
EventEnvelope.scala
val eventMetadata: Option[Any]

Attributes

Source
EventEnvelope.scala
val eventOption: Option[Event]

Attributes

Source
EventEnvelope.scala
val offset: Offset

Attributes

Source
EventEnvelope.scala

Attributes

Source
EventEnvelope.scala

Attributes

Source
EventEnvelope.scala
val slice: Int

Attributes

Source
EventEnvelope.scala

Attributes

Source
EventEnvelope.scala