ReceivedEventData interface
Event Hub から受信したイベントの構造を記述するインターフェイス。
これは、EventHubConsumerClientを使用するときにイベント ハブから受信したイベントを処理する processEvents 関数を作成するときに参照として使用します。
プロパティ
| body | 送信する必要がある、または受信する必要があるメッセージ本文。 |
| content |
メッセージのコンテンツ タイプ。 必要に応じて、メッセージのペイロードを記述します。記述子は、"application/json" など、RFC2045セクション 5 の形式に従います。 |
| correlation |
アプリケーションが関連付けの目的でメッセージのコンテキストを指定できるようにする関連付け識別子 。たとえば、応答先のメッセージの MessageId を反映します。 |
| enqueued |
イベントのエンキューされた時刻。 |
| message |
メッセージ識別子は、メッセージとそのペイロードを一意に識別するアプリケーション定義の値です。 |
| offset | イベントのオフセット。 |
| partition |
指定した場合、Event Hub はこれを partitionId にハッシュします。 これにより、メッセージがイベント ハブ上の特定のパーティションに格納されます。 |
| properties | アプリケーション固有のプロパティ。 |
| sequence |
イベントのシーケンス番号。 |
| system |
サービスによって設定されるプロパティ。 |
メソッド
| get |
基になる生の amqp メッセージを返します。 |
プロパティの詳細
body
送信する必要がある、または受信する必要があるメッセージ本文。
body: anyプロパティ値
any
contentType
メッセージのコンテンツ タイプ。 必要に応じて、メッセージのペイロードを記述します。記述子は、"application/json" など、RFC2045セクション 5 の形式に従います。
contentType?: stringプロパティ値
string
correlationId
アプリケーションが関連付けの目的でメッセージのコンテキストを指定できるようにする関連付け識別子 。たとえば、応答先のメッセージの MessageId を反映します。
correlationId?: string | number | Bufferプロパティ値
string | number | Buffer
enqueuedTimeUtc
イベントのエンキューされた時刻。
enqueuedTimeUtc: Dateプロパティ値
Date
messageId
メッセージ識別子は、メッセージとそのペイロードを一意に識別するアプリケーション定義の値です。
messageId?: string | number | Bufferプロパティ値
string | number | Buffer
offset
イベントのオフセット。
offset: numberプロパティ値
number
partitionKey
指定した場合、Event Hub はこれを partitionId にハッシュします。 これにより、メッセージがイベント ハブ上の特定のパーティションに格納されます。
partitionKey: null | stringプロパティ値
null | string
properties
アプリケーション固有のプロパティ。
properties?: {[key: string]: any}プロパティ値
{[key: string]: any}
sequenceNumber
イベントのシーケンス番号。
sequenceNumber: numberプロパティ値
number
systemProperties
サービスによって設定されるプロパティ。
systemProperties?: {[key: string]: any}プロパティ値
{[key: string]: any}