EventDataBatch interface

Paket:

@azure/event-hubs

Ett gränssnitt som representerar en batch med händelser som kan användas för att skicka händelser till Event Hub.

Om du vill skapa batchen använder du metoden createBatch() på EventHubProducerClient. Om du vill skicka batchen använder du metoden sendBatch() på samma klient. Om du vill fylla batchen använder du metoden tryAdd() på själva batchen.

Egenskaper

count	Antal händelser som lagts till i batchen.
maxSizeInBytes	Den maximala storleken på batchen, i byte. Funktionen tryAdd i batchen returnerar false om händelsen som läggs till gör att batchens storlek överskrider den här gränsen. Använd metoden createBatch() på EventHubProducerClient för att ange maxSizeInBytes.
sizeInBytes	Batchens storlek i byte efter att händelserna som lagts till i den har kodats i ett enda AMQP-meddelande.

Metoder

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Lägger till en händelse i batchen om den tillåts av batchens storleksgräns. NOTE: Kom alltid ihåg att kontrollera returvärdet för den här metoden innan du anropar den igen för nästa händelse.

Egenskapsinformation

count

Antal händelser som lagts till i batchen.

count: number

Egenskapsvärde

number

maxSizeInBytes

Den maximala storleken på batchen, i byte. Funktionen tryAdd i batchen returnerar false om händelsen som läggs till gör att batchens storlek överskrider den här gränsen. Använd metoden createBatch() på EventHubProducerClient för att ange maxSizeInBytes.

maxSizeInBytes: number

Egenskapsvärde

number

sizeInBytes

Batchens storlek i byte efter att händelserna som lagts till i den har kodats i ett enda AMQP-meddelande.

sizeInBytes: number

Egenskapsvärde

number

Metodinformation

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Lägger till en händelse i batchen om den tillåts av batchens storleksgräns. NOTE: Kom alltid ihåg att kontrollera returvärdet för den här metoden innan du anropar den igen för nästa händelse.

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

Parametrar

eventData

EventData | AmqpAnnotatedMessage

Ett enskilt händelsedataobjekt eller AmqpAnnotatedMessage.

options

TryAddOptions

Returer

boolean

Ett booleskt värde som anger om händelsedata har lagts till i batchen eller inte.