EventDataBatch interface
Een interface die een batch gebeurtenissen vertegenwoordigt die kan worden gebruikt om gebeurtenissen naar Event Hub te verzenden.
Als u de batch wilt maken, gebruikt u de createBatch() methode op de EventHubProducerClient.
Als u de batch wilt verzenden, gebruikt u de methode sendBatch() op dezelfde client.
Als u de batch wilt vullen, gebruikt u de tryAdd() methode in de batch zelf.
Eigenschappen
| count | Aantal gebeurtenissen dat aan de batch is toegevoegd. |
| max |
De maximale grootte van de batch, in bytes. De |
| size |
De grootte van de batch in bytes nadat de gebeurtenissen die eraan zijn toegevoegd, zijn gecodeerd in één AMQP-bericht. |
Methoden
| try |
Voegt een gebeurtenis toe aan de batch als dit is toegestaan door de groottelimiet van de batch. OPMERKING: vergeet niet om de retourwaarde van deze methode te controleren voordat u deze opnieuw aanroept voor de volgende gebeurtenis. |
Eigenschapdetails
count
Aantal gebeurtenissen dat aan de batch is toegevoegd.
count: number
Waarde van eigenschap
number
maxSizeInBytes
De maximale grootte van de batch, in bytes. De tryAdd-functie in de batch retourneert false als de gebeurtenis die wordt toegevoegd ervoor zorgt dat de grootte van de batch deze limiet overschrijdt. Gebruik de methode createBatch() op de EventHubProducerClient om maxSizeInBytes in te stellen.
maxSizeInBytes: number
Waarde van eigenschap
number
sizeInBytes
De grootte van de batch in bytes nadat de gebeurtenissen die eraan zijn toegevoegd, zijn gecodeerd in één AMQP-bericht.
sizeInBytes: number
Waarde van eigenschap
number
Methodedetails
tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)
Voegt een gebeurtenis toe aan de batch als dit is toegestaan door de groottelimiet van de batch. OPMERKING: vergeet niet om de retourwaarde van deze methode te controleren voordat u deze opnieuw aanroept voor de volgende gebeurtenis.
function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean
Parameters
- eventData
Een afzonderlijk gebeurtenisgegevensobject of AmqpAnnotatedMessage.
- options
- TryAddOptions
Retouren
boolean
Een Booleaanse waarde die aangeeft of de gebeurtenisgegevens zijn toegevoegd aan de batch of niet.