ServiceBusReceivedMessage Classe

Pacote:

com.azure.messaging.servicebus

Artefato Maven:

com.azure:azure-messaging-servicebus:7.17.0

• java.lang.Object
• • com.azure.messaging.servicebus.ServiceBusReceivedMessage

public final class ServiceBusReceivedMessage

A estrutura de dados que encapsula a mensagem recebida do Barramento de Serviço. A estrutura da mensagem é discutida detalhadamente na documentação do produto.

Resumo do método

Modificador e tipo	Método e descrição
Map<String,Object>	getApplicationProperties() Obtém o conjunto de propriedades de forma ServiceBusReceivedMessage livre que podem ser usadas para passar metadados associados ao durante as operações do ServiceBusReceivedMessage Barramento de Serviço.
BinaryData	getBody() Obtém a carga encapsulada pelo ServiceBusReceivedMessage.
String	getContentType() Obtém o tipo de conteúdo da mensagem.
String	getCorrelationId() Obtém um identificador de correlação.
String	getDeadLetterErrorDescription() Obtém a descrição de uma mensagem que foi enviada com mensagens mortas.
String	getDeadLetterReason() Obtém a razão pela qual uma mensagem foi morta.
String	getDeadLetterSource() Obtém o nome da fila ou da assinatura em que essa mensagem foi enfileirada, antes de ser inativa.
long	getDeliveryCount() Obtém o número de vezes que essa mensagem foi entregue aos clientes.
long	getEnqueuedSequenceNumber() Obtém o número de sequência enfileirado atribuído a uma mensagem pelo Barramento de Serviço.
OffsetDateTime	getEnqueuedTime() Obtém o datetime no qual essa mensagem foi enfileirada em Barramento de Serviço do Azure.
OffsetDateTime	getExpiresAt() Obtém o datetime no qual essa mensagem expirará.
String	getLockToken() Obtém o token de bloqueio para a mensagem atual.
OffsetDateTime	getLockedUntil() Obtém o datetime no qual o bloqueio dessa mensagem expira.
String	getMessageId() Obtém o identificador da mensagem.
String	getPartitionKey() Obtém a chave de partição para enviar uma mensagem para uma entidade particionada.
AmqpAnnotatedMessage	getRawAmqpMessage() A representação da mensagem conforme definido pelo protocolo AMQP.
String	getReplyTo() Obtém o endereço de uma entidade para a qual enviar respostas.
String	getReplyToSessionId() Obtém ou define um identificador de sessão que aumenta o getReplyTo() endereço.
OffsetDateTime	getScheduledEnqueueTime() Obtém a hora de enfileiramento agendada desta mensagem.
long	getSequenceNumber() Obtém o número exclusivo atribuído a uma mensagem pelo Barramento de Serviço.
String	getSessionId() Obtém a ID da sessão da mensagem.
ServiceBusMessageState	getState() Obtém o estado da mensagem.
String	getSubject() Obtém o assunto da mensagem.
Duration	getTimeToLive() Obtém a duração antes que essa mensagem expire.
String	getTo() Obtém o endereço "para".

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

getApplicationProperties

public Map getApplicationProperties()

Obtém o conjunto de propriedades de forma ServiceBusReceivedMessage livre que podem ser usadas para passar metadados associados ao durante as operações do ServiceBusReceivedMessage Barramento de Serviço. Um caso de uso comum para properties() é associar dicas de serialização para o getBody() como um auxílio aos consumidores que desejam desserializar os dados binários.

Returns:

Propriedades do aplicativo associadas a este ServiceBusReceivedMessage.

getBody

public BinaryData getBody()

Obtém a carga encapsulada pelo ServiceBusReceivedMessage.

A BinaryData encapsula a matriz de bytes e é uma abstração de várias maneiras diferentes de ser representada. Ele fornece APIs de conveniência para serializar/desserializar o objeto.

Se os meios para desserializar os dados brutos não forem aparentes para os consumidores, uma técnica comum será usar getApplicationProperties() ao criar o evento para associar dicas de serialização como um auxílio aos consumidores que desejam desserializar os dados binários.

Returns:

Dados binários que representam o conteúdo.

getContentType

public String getContentType()

Obtém o tipo de conteúdo da mensagem.

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

Returns:

O contentType do ServiceBusReceivedMessage.

getCorrelationId

public String getCorrelationId()

Obtém um identificador de correlação.

Permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo o MessageId de uma mensagem que está sendo respondida.

Returns:

A ID de correlação dessa mensagem.

getDeadLetterErrorDescription

public String getDeadLetterErrorDescription()

Obtém a descrição de uma mensagem que foi enviada com mensagens mortas.

Returns:

A descrição de uma mensagem que foi enviada com mensagens mortas; null Caso contrário.

getDeadLetterReason

public String getDeadLetterReason()

Obtém a razão pela qual uma mensagem foi morta.

Returns:

A razão pela qual uma mensagem foi morta de carta; null Caso contrário.

getDeadLetterSource

public String getDeadLetterSource()

Obtém o nome da fila ou da assinatura em que essa mensagem foi enfileirada, antes de ser inativa.

Esse valor só é definido em mensagens que foram enviadas com mensagens mortas e, posteriormente, encaminhadas automaticamente da fila de mensagens mortas para outra entidade.

Returns:

A entidade na qual a mensagem foi morta; null Caso contrário.

getDeliveryCount

public long getDeliveryCount()

Obtém o número de vezes que essa mensagem foi entregue aos clientes.

A contagem é incrementada quando um bloqueio de mensagem expira ou quando a mensagem é explicitamente abandonada pelo destinatário.

Returns:

contagem de entrega desta mensagem.

getEnqueuedSequenceNumber

public long getEnqueuedSequenceNumber()

Obtém o número de sequência enfileirado atribuído a uma mensagem pelo Barramento de Serviço.

O número de sequência é um inteiro exclusivo de 64 bits atribuído pela primeira vez a uma mensagem, pois é aceito em seu ponto original de envio.

Returns:

O número de sequência enfileirado desta mensagem

getEnqueuedTime

public OffsetDateTime getEnqueuedTime()

Obtém o datetime no qual essa mensagem foi enfileirada em Barramento de Serviço do Azure.

O datetime UTC no qual a mensagem foi aceita e armazenada na entidade. Para mensagens agendadas, isso reflete a hora em que a mensagem foi ativada. Esse valor pode ser usado como um indicador de tempo de chegada autoritativo e neutro quando o receptor não deseja confiar relógio do remetente.

Returns:

O datetime em que a mensagem foi enfileirada em Barramento de Serviço do Azure.

getExpiresAt

public OffsetDateTime getExpiresAt()

Obtém o datetime no qual essa mensagem expirará.

O valor é o datetime UTC para quando a mensagem está agendada para remoção e não estará mais disponível para recuperação da entidade. A expiração é controlada pela getTimeToLive() propriedade . Essa propriedade é computada de getEnqueuedTime() mais getTimeToLive().

Returns:

O OffsetDateTime no qual essa mensagem expira.

getLockToken

public String getLockToken()

Obtém o token de bloqueio para a mensagem atual.

O token de bloqueio é uma referência ao bloqueio que está sendo mantido pelo agente no PEEK_LOCK modo . Os bloqueios são usados para resolver explicitamente as mensagens, conforme explicado na documentação do produto. O token também pode ser usado para fixar o bloqueio permanentemente por meio da API de Adiamento e tirar a mensagem do fluxo de estado de entrega regular. Esta propriedade é somente para leitura.

Returns:

O token de bloqueio para esta mensagem. null para mensagens recuperadas por meio do RECEIVE_AND_DELETE modo .

getLockedUntil

public OffsetDateTime getLockedUntil()

Obtém o datetime no qual o bloqueio dessa mensagem expira.

Para mensagens recuperadas em um bloqueio (modo de recebimento peek-lock, não pré-liquidado), essa propriedade reflete o datetime UTC até o qual a mensagem é mantida bloqueada na fila/assinatura. Quando o bloqueio expira, o getDeliveryCount() é incrementado e a mensagem está novamente disponível para recuperação. Esta propriedade é somente para leitura.

Returns:

o datetime no qual o bloqueio dessa mensagem expira se a mensagem for recebida usando PEEK_LOCK o modo . Caso contrário, retornará nulo.

getMessageId

public String getMessageId()

Obtém o identificador da mensagem.

O identificador da mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu payload. O identificador é uma cadeia de caracteres de forma livre e pode refletir um GUID ou um identificador derivado do contexto do aplicativo. Se habilitado, o recurso de detecção duplicada identifica e remove o segundo e mais envios de mensagens com o mesmo messageId.

Returns:

ID do ServiceBusReceivedMessage.

getPartitionKey

public String getPartitionKey()

Obtém a chave de partição para enviar uma mensagem para uma entidade particionada.

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 getSessionId() propriedade substitui esse valor.

Returns:

A chave de partição dessa mensagem.

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

A representação da mensagem conforme definido pelo protocolo AMQP.

Returns:

a AmqpAnnotatedMessage mensagem AMQP que representa.

getReplyTo

public String getReplyTo()

Obtém 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.

Returns:

Valor da propriedade ReplyTo desta mensagem

getReplyToSessionId

public String getReplyToSessionId()

Obtém ou define um identificador de sessão que aumenta o getReplyTo() endereço.

Esse valor aumenta a informação ReplyTo e especifica qual SessionId deve ser definido para a resposta quando enviada para a entidade de resposta.

Returns:

Valor da propriedade ReplyToSessionId desta mensagem

getScheduledEnqueueTime

public OffsetDateTime getScheduledEnqueueTime()

Obtém a hora de enfileiramento agendada desta mensagem.

Esse valor é usado para disponibilidade de mensagens atrasadas. A mensagem é adicionada com segurança à fila, mas não é considerada ativa e, portanto, não pode ser recuperada até o horário de enfileiramento agendado. Lembre-se de que a mensagem pode não ser ativada (enfileirada) no datetime exato especificado; o tempo real de ativação depende da carga de trabalho da fila e do estado dela.

Returns:

o datetime no qual a mensagem será enfileirada em Barramento de Serviço do Azure

getSequenceNumber

public long getSequenceNumber()

Obtém 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 de forma monotônica e não têm intervalo. Eles passam para 0 quando o intervalo de 48 a 64 bits é esgotado. Esta propriedade é somente para leitura.

Returns:

número de sequência desta mensagem

getSessionId

public String getSessionId()

Obtém a ID da sessão da mensagem.

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. Consulte Sessões de Mensagem.

Returns:

A ID da sessão do ServiceBusReceivedMessage.

getState

public ServiceBusMessageState getState()

Obtém o estado da mensagem. O estado da mensagem pode ser Ativo, Adiado ou Agendado. Mensagens adiadas têm estado adiado, mensagens agendadas têm estado Agendado, todas as outras mensagens têm estado Ativo.

Returns:

O estado da mensagem.

getSubject

public String getSubject()

Obtém o assunto da mensagem.

Essa propriedade permite que o aplicativo indique a finalidade da mensagem para o destinatário de maneira padronizada, semelhante a uma linha do assunto de email. A propriedade AMQP mapeada é "subject".

Returns:

O assunto da mensagem.

getTimeToLive

public Duration getTimeToLive()

Obtém a duração antes que essa mensagem expire.

Esse valor é a duração relativa após a qual a mensagem expira, começando do datetime em que a mensagem foi aceita e armazenada pelo agente, conforme capturado em getScheduledEnqueueTime(). Quando não definido explicitamente, o valor presumido é o defaultTimeToLive definido para a respectiva fila ou tópico. Um valor TimeToLive no nível da mensagem não pode ser maior do que a configuração DefaultTimeToLive da entidade e será ajustado silenciosamente se for maior.

Returns:

Duração da vida útil desta mensagem

getTo

public String getTo()

Obtém 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.

Returns:

Valor da propriedade "To" desta mensagem