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 sendBatch()
methode op dezelfde client.
Als u de batch wilt vullen, gebruikt u de tryAdd()
methode voor de batch zelf.
Eigenschappen
count | Het aantal gebeurtenissen dat aan de batch is toegevoegd. |
max |
De maximale grootte van de batch, in bytes. De |
size |
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
Het 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 createBatch()
methode op de EventHubProducerClient
om maxSizeInBytes in te stellen.
maxSizeInBytes: number
Waarde van eigenschap
number
sizeInBytes
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 aan de batch zijn toegevoegd of niet.