ServiceBusReceiverOptions interface

Pacote:

@azure/service-bus

Opções para usar ao criar um recetor.

Propriedades

identifier	Define o nome para identificar o recetor. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, será usado um único aleatório.
maxAutoLockRenewalDurationInMs	A duração máxima, em milissegundos, que o bloqueio na mensagem será renovado automaticamente pelo cliente. Esta renovação automática para assim que a mensagem é liquidada. padrão: 300 * 1000 milissegundos (5 minutos). Para desativar ode renovação de bloqueio automático , defina esta opção 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 para 10 minutos, e o bloqueio de mensagem será renovado automaticamente por 4 vezes (equivalente a ter a mensagem bloqueada por 4 vezes sua duração de bloqueio aproveitando as renovações de bloqueio).
receiveMode	Representa o modo de receção para o recetor. No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas. No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila / assinatura. As mensagens que não forem resolvidas dentro da duração do bloqueio serão reentregues tantas vezes quanto a contagem máxima de entrega definida na fila/assinatura, após o que serão enviadas para uma fila de letra morta separada. Você pode resolver uma mensagem chamando os 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 deve ignorar a conversão do tipo de data em propriedades de anotações de mensagem ou propriedades de aplicativo em números ao receber a mensagem. Por padrão, as propriedades do tipo Data são convertidas em número de época UNIX para compatibilidade.
skipParsingBodyAsJson	Opção para desativar 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 subfila aplicável a qualquer fila ou assinatura. Os valores válidos são "deadLetter" e "transferDeadLetter". Para saber mais sobre filas de letra morta, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Detalhes de Propriedade

identifier

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

identifier?: string

Valor de Propriedade

string

maxAutoLockRenewalDurationInMs

A duração máxima, em milissegundos, que o bloqueio na mensagem será renovado automaticamente pelo cliente. Esta renovação automática para assim que a mensagem é liquidada.

• padrão: 300 * 1000 milissegundos (5 minutos).
• Para desativar ode renovação de bloqueio automático , defina esta opção 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 para 10 minutos, e o bloqueio de mensagem será renovado automaticamente por 4 vezes (equivalente a ter a mensagem bloqueada por 4 vezes sua duração de bloqueio aproveitando as renovações de bloqueio).

maxAutoLockRenewalDurationInMs?: number

Valor de Propriedade

number

receiveMode

Representa o modo de receção para o recetor.

No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas.

No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila / assinatura.

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

Você pode resolver uma mensagem chamando os 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 de Propriedade

"peekLock" | "receiveAndDelete"

skipConvertingDate

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

skipConvertingDate?: boolean

Valor de Propriedade

boolean

skipParsingBodyAsJson

Opção para desativar 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 de Propriedade

boolean

subQueueType

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

subQueueType?: "deadLetter" | "transferDeadLetter"

Valor de Propriedade

"deadLetter" | "transferDeadLetter"