EventDataBatch interface

Paket:

@azure/event-hubs

Eine Schnittstelle, die einen Batch von Ereignissen darstellt, die zum Senden von Ereignissen an Event Hub verwendet werden können. Verwenden Sie zum Erstellen des Batches die createBatch() -Methode für .EventHubProducerClient Verwenden Sie zum Senden des Batches die sendBatch() -Methode auf demselben Client. Um den Batch auszufüllen, verwenden Sie die tryAdd() -Methode für den Batch selbst.

Eigenschaften

count	Anzahl der Ereignisse, die dem Batch hinzugefügt wurden.
maxSizeInBytes	Die maximale Größe des Batches in Bytes. Die tryAdd Funktion für den Batch wird zurückgegeben false , wenn das hinzugefügte Ereignis dazu führt, dass die Größe des Batches diesen Grenzwert überschreitet. Verwenden Sie die createBatch() -Methode auf dem EventHubProducerClient , um maxSizeInBytes festzulegen.
sizeInBytes	Größe des Batches in Bytes, nachdem die hinzugefügten Ereignisse in eine einzelne AMQP-Nachricht codiert wurden.

Methoden

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Fügt dem Batch ein Ereignis hinzu, wenn dies durch das Größenlimit des Batches zulässig ist. HINWEIS: Denken Sie immer daran, den Rückgabewert dieser Methode zu überprüfen, bevor Sie sie für das nächste Ereignis erneut aufrufen.

Details zur Eigenschaft

count

Anzahl der Ereignisse, die dem Batch hinzugefügt wurden.

count: number

Eigenschaftswert

number

maxSizeInBytes

Die maximale Größe des Batches in Bytes. Die tryAdd Funktion für den Batch wird zurückgegeben false , wenn das hinzugefügte Ereignis dazu führt, dass die Größe des Batches diesen Grenzwert überschreitet. Verwenden Sie die createBatch() -Methode auf dem EventHubProducerClient , um maxSizeInBytes festzulegen.

maxSizeInBytes: number

Eigenschaftswert

number

sizeInBytes

Größe des Batches in Bytes, nachdem die hinzugefügten Ereignisse in eine einzelne AMQP-Nachricht codiert wurden.

sizeInBytes: number

Eigenschaftswert

number

Details zur Methode

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Fügt dem Batch ein Ereignis hinzu, wenn dies durch das Größenlimit des Batches zulässig ist. HINWEIS: Denken Sie immer daran, den Rückgabewert dieser Methode zu überprüfen, bevor Sie sie für das nächste Ereignis erneut aufrufen.

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

Parameter

eventData

EventData | AmqpAnnotatedMessage

Ein einzelnes Ereignisdatenobjekt oder AmqpAnnotatedMessage.

options

TryAddOptions

Gibt zurück

boolean

Ein boolescher Wert, der angibt, ob die Ereignisdaten dem Batch hinzugefügt wurden oder nicht.