Compartir a través de

EventDataBatch interface

  • Referencia
Paquete:
@azure/event-hubs

Interfaz que representa un lote de eventos que se pueden usar para enviar eventos al centro de eventos.

Para crear el lote, use el método createBatch() en el EventHubProducerClient. Para enviar el lote, use el método sendBatch() en el mismo cliente. Para rellenar el lote, use el método tryAdd() en el propio lote.

Propiedades

count

Número de eventos agregados al lote.
maxSizeInBytes

Tamaño máximo del lote, en bytes. La función tryAdd del lote devolverá false si el evento que se agrega hace que el tamaño del lote supere este límite. Use el método createBatch() en el EventHubProducerClient para establecer maxSizeInBytes.
sizeInBytes

Tamaño del lote en bytes después de que los eventos agregados se hayan codificado en un único mensaje AMQP.

Métodos

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Agrega un evento al lote si lo permite el límite de tamaño del lote. NOTA: recuerde comprobar siempre el valor devuelto de este método antes de llamarlo de nuevo para el siguiente evento.

Detalles de las propiedades

count

Número de eventos agregados al lote.

count: number

Valor de propiedad

number

maxSizeInBytes

Tamaño máximo del lote, en bytes. La función tryAdd del lote devolverá false si el evento que se agrega hace que el tamaño del lote supere este límite. Use el método createBatch() en el EventHubProducerClient para establecer maxSizeInBytes.

maxSizeInBytes: number

Valor de propiedad

number

sizeInBytes

Tamaño del lote en bytes después de que los eventos agregados se hayan codificado en un único mensaje AMQP.

sizeInBytes: number

Valor de propiedad

number

Detalles del método

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Agrega un evento al lote si lo permite el límite de tamaño del lote. NOTA: recuerde comprobar siempre el valor devuelto de este método antes de llamarlo de nuevo para el siguiente evento.

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

Parámetros

eventData

EventData | AmqpAnnotatedMessage

Objeto de datos de evento individual o AmqpAnnotatedMessage.

options
TryAddOptions

Devoluciones

boolean

Valor booleano que indica si los datos del evento se han agregado al lote o no.