Package org.flowable.eventregistry.api.runtime

# Interface EventInstance

public interface EventInstance
Represents a runtime event (either received or sent). The event instance is based on an `EventModel` through an associated `EventDefinition`, which typically is determined by the channel pipeline (key detection phase). The `ChannelModel` represents the channel (and pipeline) on which the event was received or, in the case of sending, needs to be sent out (can be multiple).

Author:
  Joram Barrez

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Collection<EventPayloadInstance>`
  `getCorrelationParameterInstances()`
  `String`
  `getEventKey()`
  `Collection<EventPayloadInstance>`
  `getHeaderInstances()`
  `Collection<EventPayloadInstance>`
  `getPayloadInstances()`
  `String`
  `getTenantId()`

- ## Method Details

  - ### getEventKey

    String getEventKey()

  - ### getPayloadInstances

    Collection<EventPayloadInstance> getPayloadInstances()

  - ### getHeaderInstances

    Collection<EventPayloadInstance> getHeaderInstances()

  - ### getCorrelationParameterInstances

    Collection<EventPayloadInstance> getCorrelationParameterInstances()

  - ### getTenantId

    String getTenantId()