EventDataBatch interface
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 die 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 | Die Anzahl der Ereignisse, die dem Batch hinzugefügt wurden. |
| max |
Die maximale Größe des Batches in Byte. Die |
| size |
Größe des Batches in Byte, nachdem die ereignisse, die ihr hinzugefügt wurden, in eine einzelne AMQP-Nachricht codiert wurden. |
Methoden
| try |
Fügt dem Batch ein Ereignis hinzu, sofern dies durch die Größenbeschränkung des Batches zulässig ist. HINWEIS: Denken Sie immer daran, den Rückgabewert dieser Methode zu überprüfen, bevor Sie ihn erneut für das nächste Ereignis aufrufen. |
Details zur Eigenschaft
count
Die Anzahl der Ereignisse, die dem Batch hinzugefügt wurden.
count: numberEigenschaftswert
number
maxSizeInBytes
Die maximale Größe des Batches in Byte. Die tryAdd-Funktion im Batch gibt false zurück, wenn das hinzugefügte Ereignis bewirkt, dass die Größe des Batches diesen Grenzwert überschreitet. Verwenden Sie die createBatch()-Methode für die EventHubProducerClient, um die maxSizeInBytes festzulegen.
maxSizeInBytes: numberEigenschaftswert
number
sizeInBytes
Größe des Batches in Byte, nachdem die ereignisse, die ihr hinzugefügt wurden, in eine einzelne AMQP-Nachricht codiert wurden.
sizeInBytes: numberEigenschaftswert
number
Details zur Methode
tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)
Fügt dem Batch ein Ereignis hinzu, sofern dies durch die Größenbeschränkung des Batches zulässig ist. HINWEIS: Denken Sie immer daran, den Rückgabewert dieser Methode zu überprüfen, bevor Sie ihn erneut für das nächste Ereignis aufrufen.
function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): booleanParameter
- eventData
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.