ServiceBusReceivedMessage interface

Pacote:

@azure/service-bus

Descreve a mensagem recebida do Barramento de Serviço durante as operações de inspeção e, portanto, não pode ser resolvida.

Extends

ServiceBusMessage

Propriedades

deadLetterErrorDescription	A descrição do erro para fazer deadletteing da mensagem.
deadLetterReason	O motivo para a mensagem ser morta.
deadLetterSource	O nome da fila ou assinatura na qual essa mensagem foi enfileirada, antes de ser colocada em fila. Definido apenas em mensagens que foram enviadas com mensagens mortas e, posteriormente, encaminhadas automaticamente da sub-fila de mensagens mortas para outra entidade. Indica a entidade na qual a mensagem foi morta.
deliveryCount	Número de entregas que foram tentadas para essa mensagem. A contagem é incrementada quando um bloqueio de mensagem expira ou a mensagem é explicitamente abandonada usando o abandon() método na mensagem.
enqueuedSequenceNumber	O número de sequência original da mensagem. Para mensagens que foram encaminhadas automaticamente, essa propriedade reflete o número de sequência que tinha sido atribuído primeiro à mensagem em seu ponto de envio original.
enqueuedTimeUtc	O instante UTC no qual a mensagem foi aceita e armazenada no Barramento de Serviço.
expiresAtUtc	O instante do UTC em que a mensagem é marcada para remoção e não está mais disponível para recuperação da entidade devido à expiração. Essa propriedade é calculada de duas outras propriedades na mensagem: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	O instante UTC até o qual a mensagem é mantida bloqueada na fila/assinatura. Quando o bloqueio expira, o deliveryCount é incrementado e a mensagem está novamente disponível para recuperação. Não aplicável quando a mensagem é recebida no receiveAndDelete modo de recebimento. .
lockToken	O token de bloqueio é uma referência ao bloqueio que está sendo mantido pelo agente no peekLock modo de recebimento. Os bloqueios são usados internamente para resolver mensagens, conforme explicado na documentação do produto com mais detalhes Não aplicável quando a mensagem é recebida no receiveAndDelete modo de recebimento. .
sequenceNumber	O número exclusivo atribuído a uma mensagem pelo Barramento de Serviço. O número de sequência é um inteiro de 64 bits atribuído a uma mensagem conforme ela é aceita e armazenada pelo agente e por funções como seu identificador verdadeiro. Para entidades particionadas, os 16 bits de nível mais alto refletem o identificador da partição. Os números de sequência aumentam monotonicamente. Eles passam para 0 quando o intervalo de 48 a 64 bits é esgotado. O inteiro seguro máximo que o Javascript dá suporte atualmente é 2^53 - 1. O número de sequência é um tipo AMQP Long que pode ter até 64 bits de comprimento. Para representar que estamos usando uma biblioteca chamada long.js. Esperamos que os clientes usem o Long tipo exportado por essa biblioteca.
state	O estado da mensagem pode estar ativo, adiado ou agendado. Mensagens adiadas têm estado adiado, mensagens agendadas têm estado agendado, todas as outras mensagens têm estado ativo.

Propriedades herdadas

applicationProperties	As propriedades específicas do aplicativo que podem ser usadas para metadados de mensagem personalizados.
body	O corpo da mensagem que precisa ser enviado ou recebido. Se o aplicativo que recebe a mensagem não estiver usando esse SDK, converta o conteúdo do corpo em uma matriz de bytes ou buffer para uma melhor compatibilidade entre idiomas.
contentType	O tipo de conteúdo da mensagem. Opcionalmente, descreve o conteúdo da mensagem, com um descritor seguindo o formato RFC2045, Seção 5, por exemplo , "application/json".
correlationId	O identificador de correlação que permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo a MessageId de uma mensagem que está sendo respondido. Consulte Roteamento e Correlação de Mensagens.
messageId	O identificador da mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu payload. Observação: números que não são inteiros inteiros não são permitidos.
partitionKey	A chave de partição para enviar uma mensagem para uma entidade particionada. O comprimento máximo é de 128 caracteres. Para entidades particionadas, definir esse valor permite a atribuição de mensagens relacionadas à mesma partição interna para que a ordem de sequência de envio esteja registrada corretamente. A partição é escolhida por uma função de hash sobre esse valor e não pode ser escolhida diretamente. Para entidades com reconhecimento de sessão, a sessionId propriedade substitui esse valor. Para entidades não particionadas, a chave de partição será ignorada
replyTo	O endereço de uma entidade para a qual enviar respostas. Esse valor opcional e definido pelo aplicativo é uma maneira padrão de expressar um caminho de resposta para o receptor da mensagem. Quando um remetente espera uma resposta, ele define o valor como o caminho absoluto ou relativo da fila ou do tópico para o qual ele espera que a resposta seja enviada. Consulte Roteamento e Correlação de Mensagens.
replyToSessionId	O identificador de sessão que aumenta o replyTo endereço. O comprimento máximo é de 128 caracteres. Esse valor aumenta a informação ReplyTo e especifica qual SessionId deve ser definido para a resposta quando enviada para a entidade de resposta. Consulte Roteamento e Correlação de Mensagens.
scheduledEnqueueTimeUtc	A data e a hora em UTC em que a mensagem será enfileirada. Essa propriedade retorna a hora em UTC; ao definir a propriedade , o valor de DateTime fornecido também deve estar em UTC. Esse valor é para envio de mensagens atrasadas. Ele é utilizado para atrasar o envio de mensagens para um horário específico no futuro. O tempo de enfileiramento de mensagens não significa que a mensagem será enviada ao mesmo tempo. Ele será enfileirado, mas o tempo real de envio depende da carga de trabalho da fila e do estado dela.
sessionId	O identificador de sessão para uma entidade com reconhecimento de sessão. O comprimento máximo é de 128 caracteres. Para entidades com reconhecimento de sessão, esse valor definido pelo aplicativo especifica a afiliação de sessão da mensagem. As mensagens com o mesmo identificador de sessão estão sujeitas ao bloqueio de resumo e permitem a demultiplexação e o processamento na ordem exata. Para entidades sem reconhecimento de sessão, esse valor é ignorado. Sessões de mensagem.
subject	Rótulo específico do aplicativo. Essa propriedade permite que o aplicativo indique a finalidade da mensagem para o receptor em um padronizado. moda, semelhante a uma linha de assunto de email. A propriedade AMQP mapeada é "subject".
timeToLive	O valor da vida útil da mensagem. Esse valor é a duração relativa após a qual a mensagem expira, começando do instante em que a mensagem foi aceita e armazenada pelo agente, conforme capturado em enqueuedTimeUtc. Quando não definido explicitamente, o valor assumido será o DefaultTimeToLive para a respectiva fila ou tópico. Um valor no nível timeToLive da mensagem não pode ser maior do que a configuração DefaultTimeToLive da entidade e é ajustado silenciosamente se o fizer. Confira Expiração.
to	O endereço "para". Essa propriedade é reservada para uso futuro em cenários de roteamento e é atualmente ignorada pelo próprio agente. Os aplicativos podem usar esse valor em cenários de encadeamento de encaminhamento automático controlado por regras para indicar o destino lógico pretendido da mensagem.

Detalhes da propriedade

deadLetterErrorDescription

A descrição do erro para fazer deadletteing da mensagem.

deadLetterErrorDescription?: string

Valor da propriedade

string

deadLetterReason

O motivo para a mensagem ser morta.

deadLetterReason?: string

Valor da propriedade

string

deadLetterSource

O nome da fila ou assinatura na qual essa mensagem foi enfileirada, antes de ser colocada em fila. Definido apenas em mensagens que foram enviadas com mensagens mortas e, posteriormente, encaminhadas automaticamente da sub-fila de mensagens mortas para outra entidade. Indica a entidade na qual a mensagem foi morta.

deadLetterSource?: string

Valor da propriedade

string

deliveryCount

Número de entregas que foram tentadas para essa mensagem. A contagem é incrementada quando um bloqueio de mensagem expira ou a mensagem é explicitamente abandonada usando o abandon() método na mensagem.

deliveryCount?: number

Valor da propriedade

number

enqueuedSequenceNumber

O número de sequência original da mensagem. Para mensagens que foram encaminhadas automaticamente, essa propriedade reflete o número de sequência que tinha sido atribuído primeiro à mensagem em seu ponto de envio original.

enqueuedSequenceNumber?: number

Valor da propriedade

number

enqueuedTimeUtc

O instante UTC no qual a mensagem foi aceita e armazenada no Barramento de Serviço.

enqueuedTimeUtc?: Date

Valor da propriedade

Date

expiresAtUtc

O instante do UTC em que a mensagem é marcada para remoção e não está mais disponível para recuperação da entidade devido à expiração. Essa propriedade é calculada de duas outras propriedades na mensagem: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Valor da propriedade

Date

lockedUntilUtc

O instante UTC até o qual a mensagem é mantida bloqueada na fila/assinatura. Quando o bloqueio expira, o deliveryCount é incrementado e a mensagem está novamente disponível para recuperação.

• Não aplicável quando a mensagem é recebida no receiveAndDelete modo de recebimento. .

lockedUntilUtc?: Date

Valor da propriedade

Date

lockToken

O token de bloqueio é uma referência ao bloqueio que está sendo mantido pelo agente no peekLock modo de recebimento. Os bloqueios são usados internamente para resolver mensagens, conforme explicado na documentação do produto com mais detalhes

• Não aplicável quando a mensagem é recebida no receiveAndDelete modo de recebimento. .

lockToken?: string

Valor da propriedade

string

sequenceNumber

O número exclusivo atribuído a uma mensagem pelo Barramento de Serviço. O número de sequência é um inteiro de 64 bits atribuído a uma mensagem conforme ela é aceita e armazenada pelo agente e por funções como seu identificador verdadeiro. Para entidades particionadas, os 16 bits de nível mais alto refletem o identificador da partição. Os números de sequência aumentam monotonicamente. Eles passam para 0 quando o intervalo de 48 a 64 bits é esgotado.

O inteiro seguro máximo que o Javascript dá suporte atualmente é 2^53 - 1. O número de sequência é um tipo AMQP Long que pode ter até 64 bits de comprimento. Para representar que estamos usando uma biblioteca chamada long.js. Esperamos que os clientes usem o Long tipo exportado por essa biblioteca.

sequenceNumber?: Long

Valor da propriedade

Long

state

O estado da mensagem pode estar ativo, adiado ou agendado. Mensagens adiadas têm estado adiado, mensagens agendadas têm estado agendado, todas as outras mensagens têm estado ativo.

state: "active" | "deferred" | "scheduled"

Valor da propriedade

"active" | "deferred" | "scheduled"

Detalhes das propriedades herdadas

applicationProperties

As propriedades específicas do aplicativo que podem ser usadas para metadados de mensagem personalizados.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

Valor da propriedade

{[key: string]: number | boolean | string | Date | null}

Herdado deServiceBusMessage.applicationProperties

body

O corpo da mensagem que precisa ser enviado ou recebido. Se o aplicativo que recebe a mensagem não estiver usando esse SDK, converta o conteúdo do corpo em uma matriz de bytes ou buffer para uma melhor compatibilidade entre idiomas.

body: any

Valor da propriedade

any

Herdado deServiceBusMessage.body

contentType

O tipo de conteúdo da mensagem. Opcionalmente, descreve o conteúdo da mensagem, com um descritor seguindo o formato RFC2045, Seção 5, por exemplo , "application/json".

contentType?: string

Valor da propriedade

string

Herdado deServiceBusMessage.contentType

correlationId

O identificador de correlação que permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo a MessageId de uma mensagem que está sendo respondido. Consulte Roteamento e Correlação de Mensagens.

correlationId?: string | number | Buffer

Valor da propriedade

string | number | Buffer

Herdado deServiceBusMessage.correlationId

messageId

O identificador da mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu payload.

Observação: números que não são inteiros inteiros não são permitidos.

messageId?: string | number | Buffer

Valor da propriedade

string | number | Buffer

Herdado deServiceBusMessage.messageId

partitionKey

A chave de partição para enviar uma mensagem para uma entidade particionada. O comprimento máximo é de 128 caracteres. Para entidades particionadas, definir esse valor permite a atribuição de mensagens relacionadas à mesma partição interna para que a ordem de sequência de envio esteja registrada corretamente. A partição é escolhida por uma função de hash sobre esse valor e não pode ser escolhida diretamente.

• Para entidades com reconhecimento de sessão, a sessionId propriedade substitui esse valor.
• Para entidades não particionadas, a chave de partição será ignorada

partitionKey?: string

Valor da propriedade

string

Herdado deServiceBusMessage.partitionKey

replyTo

O endereço de uma entidade para a qual enviar respostas. Esse valor opcional e definido pelo aplicativo é uma maneira padrão de expressar um caminho de resposta para o receptor da mensagem. Quando um remetente espera uma resposta, ele define o valor como o caminho absoluto ou relativo da fila ou do tópico para o qual ele espera que a resposta seja enviada. Consulte Roteamento e Correlação de Mensagens.

replyTo?: string

Valor da propriedade

string

Herdado deServiceBusMessage.replyTo

replyToSessionId

O identificador de sessão que aumenta o replyTo endereço. O comprimento máximo é de 128 caracteres. Esse valor aumenta a informação ReplyTo e especifica qual SessionId deve ser definido para a resposta quando enviada para a entidade de resposta. Consulte Roteamento e Correlação de Mensagens.

replyToSessionId?: string

Valor da propriedade

string

Herdado deServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

A data e a hora em UTC em que a mensagem será enfileirada. Essa propriedade retorna a hora em UTC; ao definir a propriedade , o valor de DateTime fornecido também deve estar em UTC. Esse valor é para envio de mensagens atrasadas. Ele é utilizado para atrasar o envio de mensagens para um horário específico no futuro. O tempo de enfileiramento de mensagens não significa que a mensagem será enviada ao mesmo tempo. Ele será enfileirado, mas o tempo real de envio depende da carga de trabalho da fila e do estado dela.

scheduledEnqueueTimeUtc?: Date

Valor da propriedade

Date

Herdado deServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

O identificador de sessão para uma entidade com reconhecimento de sessão. O comprimento máximo é de 128 caracteres. Para entidades com reconhecimento de sessão, esse valor definido pelo aplicativo especifica a afiliação de sessão da mensagem. As mensagens com o mesmo identificador de sessão estão sujeitas ao bloqueio de resumo e permitem a demultiplexação e o processamento na ordem exata. Para entidades sem reconhecimento de sessão, esse valor é ignorado. Sessões de mensagem.

sessionId?: string

Valor da propriedade

string

Herdado deServiceBusMessage.sessionId

subject

Rótulo específico do aplicativo. Essa propriedade permite que o aplicativo indique a finalidade da mensagem para o receptor em um padronizado. moda, semelhante a uma linha de assunto de email. A propriedade AMQP mapeada é "subject".

subject?: string

Valor da propriedade

string

Herdado deServiceBusMessage.subject

timeToLive

O valor da vida útil da mensagem. Esse valor é a duração relativa após a qual a mensagem expira, começando do instante em que a mensagem foi aceita e armazenada pelo agente, conforme capturado em enqueuedTimeUtc. Quando não definido explicitamente, o valor assumido será o DefaultTimeToLive para a respectiva fila ou tópico. Um valor no nível timeToLive da mensagem não pode ser maior do que a configuração DefaultTimeToLive da entidade e é ajustado silenciosamente se o fizer. Confira Expiração.

timeToLive?: number

Valor da propriedade

number

Herdado deServiceBusMessage.timeToLive

to

O endereço "para". Essa propriedade é reservada para uso futuro em cenários de roteamento e é atualmente ignorada pelo próprio agente. Os aplicativos podem usar esse valor em cenários de encadeamento de encaminhamento automático controlado por regras para indicar o destino lógico pretendido da mensagem.

to?: string

Valor da propriedade

string

Herdado deServiceBusMessage.to