Class EventEnvelope<Event>

java.lang.Object
org.apache.pekko.persistence.query.typed.EventEnvelope<Event>

public final class EventEnvelope<Event> extends Object
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

  • Constructor Details

    • EventEnvelope

      public EventEnvelope(Offset offset, String persistenceId, long sequenceNr, scala.Option<Event> eventOption, long timestamp, scala.Option<Object> eventMetadata, String entityType, int slice, boolean filtered, String source, scala.collection.immutable.Set<String> tags)
    • EventEnvelope

      public EventEnvelope(Offset offset, String persistenceId, long sequenceNr, scala.Option<Event> eventOption, long timestamp, scala.Option<Object> eventMetadata, String entityType, int slice, boolean filtered, String source)
    • EventEnvelope

      public EventEnvelope(Offset offset, String persistenceId, long sequenceNr, scala.Option<Event> eventOption, long timestamp, scala.Option<Object> eventMetadata, String entityType, int slice)
  • Method Details

    • apply

      public static <Event> EventEnvelope<Event> apply(Offset offset, String persistenceId, long sequenceNr, Event event, long timestamp, String entityType, int slice, boolean filtered, String source, scala.collection.immutable.Set<String> tags)
    • apply

      public static <Event> EventEnvelope<Event> apply(Offset offset, String persistenceId, long sequenceNr, Event event, long timestamp, String entityType, int slice)
    • apply

      public static <Event> EventEnvelope<Event> apply(Offset offset, String persistenceId, long sequenceNr, Event event, long timestamp, String entityType, int slice, boolean filtered, String source)
    • create

      public static <Event> EventEnvelope<Event> create(Offset offset, String persistenceId, long sequenceNr, Event event, long timestamp, String entityType, int slice, boolean filtered, String source, Set<String> tags)
    • create

      public static <Event> EventEnvelope<Event> create(Offset offset, String persistenceId, long sequenceNr, Event event, long timestamp, String entityType, int slice)
    • create

      public static <Event> EventEnvelope<Event> create(Offset offset, String persistenceId, long sequenceNr, Event event, long timestamp, String entityType, int slice, boolean filtered, String source)
    • unapply

      public static <Event> scala.Option<scala.Tuple5<Offset,String,Object,scala.Option<Event>,Object>> unapply(EventEnvelope<Event> arg)
    • offset

      public Offset offset()
    • persistenceId

      public String persistenceId()
    • sequenceNr

      public long sequenceNr()
    • eventOption

      public scala.Option<Event> eventOption()
    • timestamp

      public long timestamp()
    • eventMetadata

      public scala.Option<Object> eventMetadata()
    • entityType

      public String entityType()
    • slice

      public int slice()
    • filtered

      public boolean filtered()
    • source

      public String source()
    • tags

      public scala.collection.immutable.Set<String> tags()
    • event

      public Event event()
    • getEvent

      public Event getEvent()
      Java API
    • getOptionalEvent

      public Optional<Event> getOptionalEvent()
      Java API
    • getEventMetaData

      public Optional<Object> getEventMetaData()
      Java API
    • getTags

      public Set<String> getTags()
      Java API:
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object