EventData interface
イベント ハブに送信されるデータを記述するインターフェイス。
これは、EventHubProducerClient
を使用するときに送信するオブジェクトを作成するときに参照として使用します。
たとえば、{ body: "your-data" }
や
{
body: "your-data",
properties: {
propertyName: "property value"
}
}
プロパティ
body | 送信する必要があるメッセージ本文。 イベントを読み取るアプリケーションがこの SDK を使用していない場合は、言語間の互換性を向上させるために、本文のペイロードをバイト配列またはバッファーに変換します。 |
content |
メッセージのコンテンツ タイプ。 必要に応じて、メッセージのペイロードを記述します。記述子は、"application/json" など、RFC2045セクション 5 の形式に従います。 |
correlation |
アプリケーションが関連付けの目的でメッセージのコンテキストを指定できるようにする関連付け識別子 。たとえば、応答先のメッセージの MessageId を反映します。 |
message |
メッセージ識別子は、メッセージとそのペイロードを一意に識別するアプリケーション定義の値です。 注: 整数ではない数値は使用できません。 |
properties | ユーザー アプリケーションに固有のプロパティを設定するために使用できるキー値ペアのセット。 |
プロパティの詳細
body
送信する必要があるメッセージ本文。 イベントを読み取るアプリケーションがこの SDK を使用していない場合は、言語間の互換性を向上させるために、本文のペイロードをバイト配列またはバッファーに変換します。
body: any
プロパティ値
any
contentType
メッセージのコンテンツ タイプ。 必要に応じて、メッセージのペイロードを記述します。記述子は、"application/json" など、RFC2045セクション 5 の形式に従います。
contentType?: string
プロパティ値
string
correlationId
アプリケーションが関連付けの目的でメッセージのコンテキストを指定できるようにする関連付け識別子 。たとえば、応答先のメッセージの MessageId を反映します。
correlationId?: string | number | Buffer
プロパティ値
string | number | Buffer
messageId
メッセージ識別子は、メッセージとそのペイロードを一意に識別するアプリケーション定義の値です。
注: 整数ではない数値は使用できません。
messageId?: string | number | Buffer
プロパティ値
string | number | Buffer
properties
ユーザー アプリケーションに固有のプロパティを設定するために使用できるキー値ペアのセット。
properties?: {[key: string]: any}
プロパティ値
{[key: string]: any}