EventDataBatch interface

套件:

@azure/event-hubs

介面，表示可用來將事件傳送至事件中樞的事件批次。

若要建立批次，請使用 createBatch() 上的 EventHubProducerClient 方法。 若要傳送批次，請在 sendBatch() 相同的用戶端上使用 方法。 若要填滿批次，請使用 tryAdd() 批次本身上的 方法。

屬性

count	新增至批次的事件數目。
maxSizeInBytes	批次的大小上限，以位元組為單位。 tryAdd如果加入的事件導致批次大小超過此限制，批次上的函式將會傳回 false 。 createBatch()使用 上的 EventHubProducerClient 方法來設定 maxSizeInBytes。
sizeInBytes	新增至該批次的事件已編碼為單一 AMQP 訊息之後，以位元組為單位的批次大小。

方法

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

如果批次的大小限制允許，請將事件新增至批次。 注意：請務必記得檢查這個方法的傳回值，然後再針對下一個事件再次呼叫它。

屬性詳細資料

count

新增至批次的事件數目。

count: number

屬性值

number

maxSizeInBytes

批次的大小上限，以位元組為單位。 tryAdd如果加入的事件導致批次大小超過此限制，批次上的函式將會傳回 false 。 createBatch()使用 上的 EventHubProducerClient 方法來設定 maxSizeInBytes。

maxSizeInBytes: number

屬性值

number

sizeInBytes

新增至該批次的事件已編碼為單一 AMQP 訊息之後，以位元組為單位的批次大小。

sizeInBytes: number

屬性值

number

方法詳細資料

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

如果批次的大小限制允許，請將事件新增至批次。 注意：請務必記得檢查這個方法的傳回值，然後再針對下一個事件再次呼叫它。

function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

參數

eventData

EventData | AmqpAnnotatedMessage

個別的事件資料物件或 AmqpAnnotatedMessage。

options

TryAddOptions

傳回

boolean

布林值，指出事件資料是否已加入批次。