Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReceivedEventData

Package version

The interface that describes the structure of the event received from Event Hub. Use this as a reference when creating the processEvents function to process the events recieved from an Event Hub when using the EventHubConsumerClient.

Hierarchy

  • ReceivedEventData

Index

Properties

Properties

body

body: any

The message body that needs to be sent or is received.

enqueuedTimeUtc

enqueuedTimeUtc: Date

The enqueued time of the event.

offset

offset: number

The offset of the event.

partitionKey

partitionKey: string | null

When specified Event Hub will hash this to a partitionId. It guarantees that messages end up in a specific partition on the event hub.

Optional properties

properties: undefined | {}

The application specific properties.

sequenceNumber

sequenceNumber: number

The sequence number of the event.

Optional systemProperties

systemProperties: undefined | {}

The properties set by the service.

Generated using TypeDoc