EventDataBatch interface

Pacchetto:

@azure/event-hubs

Interfaccia che rappresenta un batch di eventi che possono essere usati per inviare eventi a Hub eventi.

Per creare il batch, usare il createBatch() metodo in EventHubProducerClient. Per inviare il batch, usare il sendBatch() metodo nello stesso client. Per riempire il batch, usare il tryAdd() metodo nel batch stesso.

Proprietà

count	Numero di eventi aggiunti al batch.
maxSizeInBytes	Dimensioni massime del batch, in byte. La tryAdd funzione nel batch restituirà false se l'evento aggiunto causa l'superamento del limite della dimensione del batch. Utilizzare il createBatch() metodo su EventHubProducerClient per impostare maxSizeInBytes.
sizeInBytes	Dimensioni del batch in byte dopo che gli eventi aggiunti sono stati codificati in un singolo messaggio AMQP.

Metodi

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Aggiunge un evento al batch se consentito dal limite di dimensioni del batch. NOTA: ricorda sempre di controllare il valore restituito di questo metodo, prima di chiamarlo di nuovo per l'evento successivo.

Dettagli proprietà

count

Numero di eventi aggiunti al batch.

count: number

Valore della proprietà

number

maxSizeInBytes

Dimensioni massime del batch, in byte. La tryAdd funzione nel batch restituirà false se l'evento aggiunto causa l'superamento del limite della dimensione del batch. Utilizzare il createBatch() metodo su EventHubProducerClient per impostare maxSizeInBytes.

maxSizeInBytes: number

Valore della proprietà

number

sizeInBytes

Dimensioni del batch in byte dopo che gli eventi aggiunti sono stati codificati in un singolo messaggio AMQP.

sizeInBytes: number

Valore della proprietà

number

Dettagli metodo

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Aggiunge un evento al batch se consentito dal limite di dimensioni del batch. NOTA: ricorda sempre di controllare il valore restituito di questo metodo, prima di chiamarlo di nuovo per l'evento successivo.

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

Parametri

eventData

EventData | AmqpAnnotatedMessage

Un singolo oggetto dati evento o AmqpAnnotatedMessage.

options

TryAddOptions

Restituisce

boolean

Valore booleano che indica se i dati dell'evento sono stati aggiunti al batch o meno.