EventData Class

Definition

The data structure encapsulating the Event being sent-to and received-from EventHubs. Each EventHubs partition can be visualized as a Stream of EventData.

public class EventData : IDisposable
type EventData = class
    interface IDisposable
Public Class EventData
Implements IDisposable
Inheritance
EventData
Implements

Constructors

EventData(ArraySegment<Byte>)

Construct EventData to send to EventHub. Typical pattern to create a Sending EventData is:

i. Serialize the sending ApplicationEvent to be sent to EventHub into bytes.

ii. If complex serialization logic is involved (for example: multiple types of data) - add a Hint using the Properties for the Consumer.

EventData(Byte[])

Construct EventData to send to EventHub. Typical pattern to create a Sending EventData is:

i. Serialize the sending ApplicationEvent to be sent to EventHubs into bytes.

ii. If complex serialization logic is involved (for example: multiple types of data) - add a Hint using the Properties for the Consumer.

Properties

Body

Get the actual Payload/Data wrapped by EventData. This is intended to be used after receiving EventData using PartitionReceiver.

Properties

Application property bag

SystemProperties

SystemProperties that are populated by EventHubService. As these are populated by Service, they are only present on a Received EventData.

Methods

Dispose()

Disposes resources attached to an Event Data

Extension Methods

ExtractActivity(EventData, String)

Creates System.Diagnostics.Activity based on the tracing context stored in the EventDataThe event received from EventHubOptional Activity nameNew System.Diagnostics.Activity with tracing context

Applies to