EventDataBatch interface
Interfaz que representa un lote de eventos que se pueden usar para enviar eventos al centro de eventos.
Para crear el lote, use el createBatch()
método en .EventHubProducerClient
Para enviar el lote, use el sendBatch()
método en el mismo cliente.
Para rellenar el lote, use el tryAdd()
método en el propio lote.
Propiedades
count | Número de eventos agregados al lote. |
max |
Tamaño máximo del lote, en bytes. La |
size |
Tamaño del lote en bytes después de que los eventos agregados a él se hayan codificado en un único mensaje AMQP. |
Métodos
try |
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 tryAdd
función del lote devolverá false
si el evento que se va a agregar hace que el tamaño del lote supere este límite. Use el createBatch()
método en EventHubProducerClient
para establecer maxSizeInBytes.
maxSizeInBytes: number
Valor de propiedad
number
sizeInBytes
Tamaño del lote en bytes después de que los eventos agregados a él 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
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.