ReceivedEventData interface

套件:

@azure/event-hubs

介面，描述從事件中樞接收之事件的結構。 在使用 時建立 函式以處理從事件中樞接收的事件時 processEventsEventHubConsumerClient ，請使用此做為參考。

屬性

body	需要傳送或接收的訊息本文。
contentType	訊息的內容型別。 選擇性地描述訊息的承載，其描述項遵循 RFC2045 第 5 節的格式，例如「application/json」。
correlationId	相互關聯識別碼，可讓應用程式指定訊息的內容，以便進行相互關聯，例如反映正在回復之訊息的 MessageId。
enqueuedTimeUtc	事件的排入佇列時間。
messageId	訊息識別碼是應用程式定義的值，可唯一識別訊息及其承載。
offset	事件的位移。
partitionKey	當指定的事件中樞將這個雜湊至 partitionId 時。 它保證訊息最終會在事件中樞的特定分割區中。
properties	應用程式特定屬性。
sequenceNumber	事件的序號。
systemProperties	服務所設定的屬性。

方法

getRawAmqpMessage()

傳回基礎原始 amqp 訊息。

屬性詳細資料

body

需要傳送或接收的訊息本文。

body: any

屬性值

any

contentType

訊息的內容型別。 選擇性地描述訊息的承載，其描述項遵循 RFC2045 第 5 節的格式，例如「application/json」。

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

當指定的事件中樞將這個雜湊至 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}

方法詳細資料

getRawAmqpMessage()

傳回基礎原始 amqp 訊息。

function getRawAmqpMessage(): AmqpAnnotatedMessage

傳回

AmqpAnnotatedMessage