ServiceBusMessageBatch interface

Paquete:

@azure/service-bus

Un lote de mensajes que puede crear mediante el método <xref:createBatch>.

Propiedades

count	Número de mensajes agregados al lote.
maxSizeInBytes	Tamaño máximo del lote, en bytes. La función tryAddMessage del lote devolverá false si el mensaje que se agrega hace que el tamaño del lote supere este límite. Use el método createMessageBatch() en el Sender 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

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Agrega un mensaje 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 mensajes agregados al lote.

count: number

Valor de propiedad

number

maxSizeInBytes

Tamaño máximo del lote, en bytes. La función tryAddMessage del lote devolverá false si el mensaje que se agrega hace que el tamaño del lote supere este límite. Use el método createMessageBatch() en el Sender 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

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Agrega un mensaje 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 tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

Parámetros

message

ServiceBusMessage | AmqpAnnotatedMessage

Mensaje que se va a agregar al lote.

options

TryAddOptions

Devoluciones

boolean

Valor booleano que indica si el mensaje se ha agregado al lote o no.