Sdílet prostřednictvím

EventDataBatch interface

  • Reference
Balíček:
@azure/event-hubs

Rozhraní představující dávku událostí, kterou je možné použít k odesílání událostí do centra událostí.

K vytvoření dávky použijte metodu createBatch() na EventHubProducerClient. K odeslání dávky použijte metodu na sendBatch() stejném klientovi. K vyplnění dávky použijte metodu tryAdd() přímo v dávce.

Vlastnosti

count

Počet událostí přidaných do dávky
maxSizeInBytes

Maximální velikost dávky v bajtech. Funkce tryAdd dávky se vrátí false , pokud přidaná událost způsobí, že velikost dávky překročí tento limit. createBatch() K nastavení maxSizeInBytes použijte metodu EventHubProducerClient na .
sizeInBytes

Velikost dávky v bajtech po přidání událostí do dávky byla zakódována do jedné zprávy AMQP.

Metody

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Přidá událost do dávky, pokud to umožňuje limit velikosti dávky. POZNÁMKA: Vždy nezapomeňte zkontrolovat vrácenou hodnotu této metody, než ji znovu zavoláte pro další událost.

Podrobnosti vlastnosti

count

Počet událostí přidaných do dávky

count: number

Hodnota vlastnosti

number

maxSizeInBytes

Maximální velikost dávky v bajtech. Funkce tryAdd dávky se vrátí false , pokud přidaná událost způsobí, že velikost dávky překročí tento limit. createBatch() K nastavení maxSizeInBytes použijte metodu EventHubProducerClient na .

maxSizeInBytes: number

Hodnota vlastnosti

number

sizeInBytes

Velikost dávky v bajtech po přidání událostí do dávky byla zakódována do jedné zprávy AMQP.

sizeInBytes: number

Hodnota vlastnosti

number

Podrobnosti metody

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Přidá událost do dávky, pokud to umožňuje limit velikosti dávky. POZNÁMKA: Vždy nezapomeňte zkontrolovat vrácenou hodnotu této metody, než ji znovu zavoláte pro další událost.

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

Parametry

eventData

EventData | AmqpAnnotatedMessage

Jednotlivý objekt dat události nebo AmqpAnnotatedMessage.

options
TryAddOptions

Návraty

boolean

Logická hodnota označující, jestli byla data události přidána do dávky nebo ne.