ServiceBusReceiverOptions interface

Paquete:

@azure/service-bus

Opciones que se usarán al crear un receptor.

Propiedades

identifier	Establece el nombre para identificar el receptor. Esto se puede usar para correlacionar registros y excepciones. Si no se especifica o está vacío, se usará una única aleatoria.
maxAutoLockRenewalDurationInMs	La duración máxima, en milisegundos, que el cliente renovará automáticamente el bloqueo del mensaje. Esta renovación automática se detiene una vez que se resuelve el mensaje. Valor predeterminado: 300 * 1000 milisegundos (5 minutos). Para deshabilitar la renovación de bloqueo automático, establezca esta opción en 0. Ejemplo: Si el bloqueo del mensaje expira en 2 minutos y el tiempo de procesamiento del mensaje es de 8 minutos... Establezca maxAutoLockRenewalDurationInMs en 10 minutos y el bloqueo del mensaje se renovará automáticamente durante 4 veces (equivalente a que el mensaje se bloquee durante 4 veces su duración de bloqueo aprovechando las renovaciones de bloqueo).
receiveMode	Representa el modo de recepción del receptor. En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben. En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola o suscripción. Los mensajes que no se liquidan dentro de la duración del bloqueo se volverán a entregar tantas veces como el número máximo de entrega establecido en la cola o suscripción, después de lo cual se envían a una cola de mensajes fallidos independiente. Puede liquidar un mensaje llamando a métodos complete(), abandon(), defer() o deadletter() en el mensaje. Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Si se omite la conversión del tipo date en propiedades de anotaciones de mensaje o propiedades de la aplicación en números al recibir el mensaje. De forma predeterminada, las propiedades del tipo Date se convierten en el número de época de UNIX por motivos de compatibilidad.
skipParsingBodyAsJson	Opción para deshabilitar que el cliente ejecute JSON.parse() en el cuerpo del mensaje al recibir el mensaje. No es aplicable si el mensaje se envió con el valor o secuencia del tipo de cuerpo AMQP. Use esta opción cuando prefiera trabajar directamente con los bytes presentes en el cuerpo del mensaje que si el cliente intenta analizarlo.
subQueueType	Representa la sub cola que se aplica a cualquier cola o suscripción. Los valores válidos son "deadLetter" y "transferDeadLetter". Para más información sobre las colas de mensajes fallidos, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Detalles de las propiedades

identifier

Establece el nombre para identificar el receptor. Esto se puede usar para correlacionar registros y excepciones. Si no se especifica o está vacío, se usará una única aleatoria.

identifier?: string

Valor de propiedad

string

maxAutoLockRenewalDurationInMs

La duración máxima, en milisegundos, que el cliente renovará automáticamente el bloqueo del mensaje. Esta renovación automática se detiene una vez que se resuelve el mensaje.

• Valor predeterminado: 300 * 1000 milisegundos (5 minutos).
• Para deshabilitar la renovación de bloqueo automático, establezca esta opción en 0.

Ejemplo:

Si el bloqueo del mensaje expira en 2 minutos y el tiempo de procesamiento del mensaje es de 8 minutos...

Establezca maxAutoLockRenewalDurationInMs en 10 minutos y el bloqueo del mensaje se renovará automáticamente durante 4 veces (equivalente a que el mensaje se bloquee durante 4 veces su duración de bloqueo aprovechando las renovaciones de bloqueo).

maxAutoLockRenewalDurationInMs?: number

Valor de propiedad

number

receiveMode

Representa el modo de recepción del receptor.

En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola o suscripción.

Los mensajes que no se liquidan dentro de la duración del bloqueo se volverán a entregar tantas veces como el número máximo de entrega establecido en la cola o suscripción, después de lo cual se envían a una cola de mensajes fallidos independiente.

Puede liquidar un mensaje llamando a métodos complete(), abandon(), defer() o deadletter() en el mensaje.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Valor de propiedad

"peekLock" | "receiveAndDelete"

skipConvertingDate

Si se omite la conversión del tipo date en propiedades de anotaciones de mensaje o propiedades de la aplicación en números al recibir el mensaje. De forma predeterminada, las propiedades del tipo Date se convierten en el número de época de UNIX por motivos de compatibilidad.

skipConvertingDate?: boolean

Valor de propiedad

boolean

skipParsingBodyAsJson

Opción para deshabilitar que el cliente ejecute JSON.parse() en el cuerpo del mensaje al recibir el mensaje. No es aplicable si el mensaje se envió con el valor o secuencia del tipo de cuerpo AMQP. Use esta opción cuando prefiera trabajar directamente con los bytes presentes en el cuerpo del mensaje que si el cliente intenta analizarlo.

skipParsingBodyAsJson?: boolean

Valor de propiedad

boolean

subQueueType

Representa la sub cola que se aplica a cualquier cola o suscripción. Los valores válidos son "deadLetter" y "transferDeadLetter". Para más información sobre las colas de mensajes fallidos, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Valor de propiedad

"deadLetter" | "transferDeadLetter"