EventDataBatch interface

Pakiet:

@azure/event-hubs

Interfejs reprezentujący partię zdarzeń, których można użyć do wysyłania zdarzeń do centrum zdarzeń.

Aby utworzyć partię, użyj createBatch() metody w pliku EventHubProducerClient. Aby wysłać partię, użyj sendBatch() metody na tym samym kliencie. Aby wypełnić partię, użyj tryAdd() metody w samej partii.

Właściwości

count	Liczba zdarzeń dodanych do partii.
maxSizeInBytes	Maksymalny rozmiar partii w bajtach. Funkcja tryAdd w partii zostanie zwrócona false , jeśli dodawane zdarzenie spowoduje przekroczenie tego limitu przez rozmiar partii. createBatch() Użyj metody w obiekcie , EventHubProducerClient aby ustawić wartość maxSizeInBytes.
sizeInBytes	Rozmiar partii w bajtach po dodaniu zdarzeń do niego został zakodowany w jednym komunikacie AMQP.

Metody

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Dodaje zdarzenie do partii, jeśli jest dozwolone przez limit rozmiaru partii. UWAGA: Zawsze pamiętaj, aby sprawdzić wartość zwracaną tej metody, zanim wywołaj ją ponownie dla następnego zdarzenia.

Szczegóły właściwości

count

Liczba zdarzeń dodanych do partii.

count: number

Wartość właściwości

number

maxSizeInBytes

Maksymalny rozmiar partii w bajtach. Funkcja tryAdd w partii zostanie zwrócona false , jeśli dodawane zdarzenie spowoduje przekroczenie tego limitu przez rozmiar partii. createBatch() Użyj metody w obiekcie , EventHubProducerClient aby ustawić wartość maxSizeInBytes.

maxSizeInBytes: number

Wartość właściwości

number

sizeInBytes

Rozmiar partii w bajtach po dodaniu zdarzeń do niego został zakodowany w jednym komunikacie AMQP.

sizeInBytes: number

Wartość właściwości

number

Szczegóły metody

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Dodaje zdarzenie do partii, jeśli jest dozwolone przez limit rozmiaru partii. UWAGA: Zawsze pamiętaj, aby sprawdzić wartość zwracaną tej metody, zanim wywołaj ją ponownie dla następnego zdarzenia.

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

Parametry

eventData

EventData | AmqpAnnotatedMessage

Pojedynczy obiekt danych zdarzenia lub AmqpAnnotatedMessage.

options

TryAddOptions

Zwraca

boolean

Wartość logiczna wskazująca, czy dane zdarzenia zostały dodane do partii, czy nie.