CloudEvent クラス

定義

名前空間:

Azure.Messaging

アセンブリ:

Azure.Core.dll

パッケージ:

Azure.Core v1.40.0

ソース:

CloudEvent.cs

1.0 スキーマに準拠する CloudEvent を表します。 この型には、System.Text.Json を使用したシリアル化が組み込まれています。

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Messaging.CloudEventConverter))]
public class CloudEvent

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Messaging.CloudEventConverter))>]
type CloudEvent = class

Public Class CloudEvent

継承

Object

CloudEvent

属性

JsonConverterAttribute

コンストラクター

CloudEvent(String, String, BinaryData, String, CloudEventDataFormat)	バイナリ イベント データを使用して、 クラスの CloudEvent 新しいインスタンスを初期化します。
CloudEvent(String, String, Object, Type)	CloudEvent クラスの新しいインスタンスを初期化します。

プロパティ

Data	イベント データを として BinaryData取得または設定します。 BinaryData を使用すると、ペイロードをリッチ データに逆シリアル化したり、 を使用して ToString()生の JSON データにアクセスしたりできます。
DataContentType	データのコンテンツ タイプを取得または設定します。
DataSchema	データが準拠するスキーマを取得または設定します。
ExtensionAttributes	CloudEvent エンベロープに追加できる拡張属性を取得します。
Id	イベントの識別子を取得または設定します。 と Source の組み合わせは、個別のIdイベントごとに一意である必要があります。 明示的に設定されていない場合、これは既定で Guidに設定されます。
Source	イベントが発生したコンテキストを取得または設定します。 と Source の組み合わせは、個別のIdイベントごとに一意である必要があります。
Subject	イベント プロデューサー (ソースによって識別される) のコンテキストでのイベントの件名を取得または設定します。
Time	イベントが生成された時刻 (UTC) を RFC3339 形式で取得または設定します。 明示的に設定しない場合、これは既定でイベントが構築された時刻になります。
Type	発生元に関連するイベントの種類を取得または設定します。

メソッド

Parse(BinaryData, Boolean)	1 つの JSON でエンコードされたイベントが指定された場合、イベント エンベロープを解析し、 を CloudEvent返します。 指定したイベントが有効な JSON でない場合は、例外がスローされます。 既定では、イベントに必須プロパティがない場合は例外がスローされますが、 パラメーターを skipValidation 設定することで緩和できます。
ParseMany(BinaryData, Boolean)	JSON でエンコードされたイベントを指定すると、イベント エンベロープが解析され、CloudEvents の配列が返されます。 指定したイベントが有効な JSON でない場合は、例外がスローされます。 既定では、イベントに必須プロパティがない場合は例外がスローされますが、 パラメーターを skipValidation 設定することで緩和できます。

拡張メソッド

TryGetSystemEventData(CloudEvent, Object)

イベントがシステム定義イベントであるかどうかを取得し、out パラメーターを使用して逆シリアル化されたシステム イベント データを返します。