EventDataBatch interface

套件:

@azure/event-hubs

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

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

屬性

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

方法

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

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

屬性詳細資料

count

新增至批次的事件數目。

count: number

屬性值

number

maxSizeInBytes

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

maxSizeInBytes: number

屬性值

number

sizeInBytes

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

sizeInBytes: number

屬性值

number

方法詳細資料

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

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

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

參數

eventData

EventData | AmqpAnnotatedMessage

個別事件數據物件或 AmqpAnnotatedMessage。

options

TryAddOptions

傳回

boolean

布爾值，指出事件數據是否已加入批次。