Azure.Messaging.CloudEvent

CloudEvent

public class CloudEvent

Represents a CloudEvent conforming to the 1.0 schema. This type has built-in serialization using System.Text.Json.

public BinaryData Data { get; set; }

Gets or sets the event data as BinaryData. Using BinaryData, one can deserialize the payload into rich data, or access the raw JSON data using ToString.

public string DataContentType { get; set; }

Gets or sets the content type of the data.

public string DataSchema { get; set; }

Gets or sets the schema that the data adheres to.

public IDictionary<string, object> ExtensionAttributes { get; }

Gets extension attributes that can be additionally added to the CloudEvent envelope.

public string Id { get; set; }

Gets or sets an identifier for the event. The combination of Id and Source must be unique for each distinct event. If not explicitly set, this will default to a Guid.

public string Source { get; set; }

Gets or sets the context in which an event happened. The combination of Id and Source must be unique for each distinct event.

public string Subject { get; set; }

Gets or sets the subject of the event in the context of the event producer (identified by source).

public DateTimeOffset? Time { get; set; }

Gets or sets the time (in UTC) the event was generated, in RFC3339 format. If not explicitly set, this will default to the time that the event is constructed.

public string Type { get; set; }

Gets or sets the type of event related to the originating occurrence.

public CloudEvent(string source, string type, object jsonSerializableData, Type dataSerializationType = null)

Initializes a new instance of the CloudEvent class.

public CloudEvent(string source, string type, BinaryData data, string dataContentType, CloudEventDataFormat dataFormat = 0)

Initializes a new instance of the CloudEvent class using binary event data.

public static CloudEvent Parse(BinaryData json, bool skipValidation = false)

Given a single JSON-encoded event, parses the event envelope and returns a CloudEvent. If the specified event is not valid JSON an exception is thrown. By default, if the event is missing required properties, an exception is thrown though this can be relaxed by setting the skipValidation parameter.

public static CloudEvent[] ParseMany(BinaryData json, bool skipValidation = false)

Given JSON-encoded events, parses the event envelope and returns an array of CloudEvents. If the specified event is not valid JSON an exception is thrown. By default, if the event is missing required properties, an exception is thrown though this can be relaxed by setting the skipValidation parameter.