ServiceBusReceiverOptions interface

Pacote:

@azure/service-bus

Opções a serem usadas ao criar um receptor.

Propriedades

identifier	Define o nome para identificar o receptor. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, um exclusivo aleatório será usado.
maxAutoLockRenewalDurationInMs	A duração máxima, em milissegundos, de que o bloqueio na mensagem será renovado automaticamente pelo cliente. Essa renovação automática é interrompida quando a mensagem é resolvida. Padrão: 300 * 1000 milissegundos (5 minutos). Para desabilitar a renovação do bloqueio automático, defina isso como 0. Exemplo: Se o bloqueio de mensagem expirar em 2 minutos e o tempo de processamento da mensagem for de 8 minutos... Defina maxAutoLockRenewalDurationInMs como 10 minutos e o bloqueio de mensagem será renovado automaticamente por 4 vezes (equivalente a ter a mensagem bloqueada por 4 vezes a duração do bloqueio aproveitando as renovações de bloqueio).
receiveMode	Representa o modo de recebimento para o receptor. No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas. No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila/assinatura. As mensagens que não forem resolvidas dentro da duração do bloqueio serão entregues novamente tantas vezes quanto a contagem máxima de entrega definida na fila/assinatura, após a qual elas são enviadas para uma fila de mensagens mortas separada. Você pode resolver uma mensagem chamando métodos complete(), abandon(), defer() ou deadletter() na mensagem. Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Se deseja ignorar a conversão de Tipo de data em propriedades de anotações de mensagens ou propriedades do aplicativo em números ao receber a mensagem. Por padrão, as propriedades do tipo Date são convertidas em número de época UNIX para compatibilidade.
skipParsingBodyAsJson	Opção para desabilitar o cliente de executar JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem foi enviada com o valor ou sequência do tipo de corpo AMQP. Use essa opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que fazer com que o cliente tente analisá-la.
subQueueType	Representa a sub fila aplicável a qualquer fila ou assinatura. Os valores válidos são "deadLetter" e "transferDeadLetter". Para saber mais sobre filas de mensagens mortas, confira https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Detalhes da propriedade

identifier

Define o nome para identificar o receptor. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, um exclusivo aleatório será usado.

identifier?: string

Valor da propriedade

string

maxAutoLockRenewalDurationInMs

A duração máxima, em milissegundos, de que o bloqueio na mensagem será renovado automaticamente pelo cliente. Essa renovação automática é interrompida quando a mensagem é resolvida.

• Padrão: 300 * 1000 milissegundos (5 minutos).
• Para desabilitar a renovação do bloqueio automático, defina isso como 0.

Exemplo:

Se o bloqueio de mensagem expirar em 2 minutos e o tempo de processamento da mensagem for de 8 minutos...

Defina maxAutoLockRenewalDurationInMs como 10 minutos e o bloqueio de mensagem será renovado automaticamente por 4 vezes (equivalente a ter a mensagem bloqueada por 4 vezes a duração do bloqueio aproveitando as renovações de bloqueio).

maxAutoLockRenewalDurationInMs?: number

Valor da propriedade

number

receiveMode

Representa o modo de recebimento para o receptor.

No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila/assinatura.

As mensagens que não forem resolvidas dentro da duração do bloqueio serão entregues novamente tantas vezes quanto a contagem máxima de entrega definida na fila/assinatura, após a qual elas são enviadas para uma fila de mensagens mortas separada.

Você pode resolver uma mensagem chamando métodos complete(), abandon(), defer() ou deadletter() na mensagem.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Valor da propriedade

"peekLock" | "receiveAndDelete"

skipConvertingDate

Se deseja ignorar a conversão de Tipo de data em propriedades de anotações de mensagens ou propriedades do aplicativo em números ao receber a mensagem. Por padrão, as propriedades do tipo Date são convertidas em número de época UNIX para compatibilidade.

skipConvertingDate?: boolean

Valor da propriedade

boolean

skipParsingBodyAsJson

Opção para desabilitar o cliente de executar JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem foi enviada com o valor ou sequência do tipo de corpo AMQP. Use essa opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que fazer com que o cliente tente analisá-la.

skipParsingBodyAsJson?: boolean

Valor da propriedade

boolean

subQueueType

Representa a sub fila aplicável a qualquer fila ou assinatura. Os valores válidos são "deadLetter" e "transferDeadLetter". Para saber mais sobre filas de mensagens mortas, confira https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Valor da propriedade

"deadLetter" | "transferDeadLetter"