Class EventData | Azure SDK for .NET

A set of data encapsulating an event and the associated metadata for use with Event Hubs operations.

Inheritance

System.Object

EventData

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Messaging.EventHubs.dll

Syntax

public class EventData

Constructors

EventData(BinaryData)

Initializes a new instance of the EventData class.

Declaration

public EventData (BinaryData eventBody);

Parameters

EventData(ReadOnlyMemory<Byte>)

Initializes a new instance of the EventData class.

Declaration

public EventData (ReadOnlyMemory<byte> eventBody);

Parameters

EventData(BinaryData, IDictionary<String,Object>, IReadOnlyDictionary<String,Object>, Int64, Int64, DateTimeOffset, String)

Initializes a new instance of the EventData class.

Declaration

[System.ComponentModel.EditorBrowsable] protected EventData (BinaryData eventBody, System.Collections.Generic.IDictionary<string,object> properties = null, System.Collections.Generic.IReadOnlyDictionary<string,object> systemProperties = null, long sequenceNumber = -9223372036854775808, long offset = -9223372036854775808, DateTimeOffset enqueuedTime = null, string partitionKey = null);

Parameters

EventData(ReadOnlyMemory<Byte>, IDictionary<String,Object>, IReadOnlyDictionary<String,Object>, Int64, Int64, DateTimeOffset, String)

Initializes a new instance of the EventData class.

Declaration

[System.ComponentModel.EditorBrowsable] protected EventData (ReadOnlyMemory<byte> eventBody, System.Collections.Generic.IDictionary<string,object> properties = null, System.Collections.Generic.IReadOnlyDictionary<string,object> systemProperties = null, long sequenceNumber = -9223372036854775808, long offset = -9223372036854775808, DateTimeOffset enqueuedTime = null, string partitionKey = null);

Parameters

Properties

Body

The data associated with the event.

Declaration

[System.ComponentModel.EditorBrowsable] public ReadOnlyMemory<byte> Body { get; }

Property Value

Remarks

See Also

BodyAsStream

The data associated with the event, in stream form.

Declaration

[System.ComponentModel.EditorBrowsable] public System.IO.Stream BodyAsStream { get; }

Property Value

Remarks

See Also

EnqueuedTime

The date and time, in UTC, of when the event was enqueued in the Event Hub partition.

Declaration

public DateTimeOffset EnqueuedTime { get; }

Property Value

EventBody

The data associated with the event, in System.BinaryData form, providing support for a variety of data transformations and Azure.Core.Serialization.ObjectSerializer integration.

Declaration

public BinaryData EventBody { get; }

Property Value

Remarks

See Also

Offset

The offset of the event when it was received from the associated Event Hub partition.

Declaration

public long Offset { get; }

Property Value

PartitionKey

The partition hashing key applied to the batch that the associated EventData, was published with.

Declaration

public string PartitionKey { get; }

Property Value

Properties

The set of free-form event properties which may be used for passing metadata associated with the event body during Event Hubs operations.

Declaration

public System.Collections.Generic.IDictionary<string,object> Properties { get; }

Property Value

Examples

 var eventData = new EventData(serializedTelemetryData); eventData.Properties["eventType"] = "com.microsoft.Azure.monitoring.EtlEvent"; 

SequenceNumber

The sequence number assigned to the event when it was enqueued in the associated Event Hub partition.

Declaration

public long SequenceNumber { get; }

Property Value

SystemProperties

The set of free-form event properties which were provided by the Event Hubs service to pass metadata associated with the event or associated Event Hubs operation.

Declaration

public System.Collections.Generic.IReadOnlyDictionary<string,object> SystemProperties { get; }

Property Value

Methods

Equals(Object)

Determines whether the specified System.Object is equal to this instance.

Declaration

[System.ComponentModel.EditorBrowsable] public override bool Equals (object obj);

Parameters

Returns

GetHashCode()

Returns a hash code for this instance.

Declaration

[System.ComponentModel.EditorBrowsable] public override int GetHashCode ();

Returns

ToString()

Converts the instance to string representation.

Declaration

[System.ComponentModel.EditorBrowsable] public override string ToString ();

Returns

ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnplonJ%2Bpu6bAjnqxrqqVY5qmv9KanqKml2OSt7HNrX%2BumqNkgm%2BAjWpmmqiZZI67wdGeZYado6iuqLXNoGV%2BrpWjwYnBwaxmerKlp7JvmcSsqpqfmaO0b5HVnqWtgKWXwG%2BR1Z6lrXyRqa5vtNOmow%3D%3D