ServiceBusMessage Classe

Pacote:

com.azure.messaging.servicebus

Artefato Maven:

com.azure:azure-messaging-servicebus:7.17.0

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

public class ServiceBusMessage

A estrutura de dados que encapsula a mensagem que está sendo enviada ao Barramento de Serviço. A estrutura da mensagem é discutida detalhadamente na documentação do produto.

Resumo do Construtor

Construtor	Description
ServiceBusMessage(byte[] body)	Cria um ServiceBusMessage com o corpo da matriz de bytes fornecido.
ServiceBusMessage(AmqpMessageBody amqpMessageBody)	Esse construtor fornece uma maneira fácil de criar ServiceBusMessage com o corpo da mensagem como tipos SEQUENCE de dados AMQP e VALUE.
ServiceBusMessage(BinaryData body)	Cria um ServiceBusMessage que contém o body. O BinaryData fornece várias API de conveniência que representam a matriz de bytes.
ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)	Cria um ServiceBusMessage usando propriedades de receivedMessage.
ServiceBusMessage(String body)	Cria um ServiceBusMessage com um UTF-8 corpo codificado.

Resumo do método

Modificador e tipo	Método e descrição
ServiceBusMessage	addContext(String key, Object value) Adiciona um novo par de valores de chave ao contexto existente em Mensagem.
Map<String,Object>	getApplicationProperties() Obtém o conjunto de propriedades de forma ServiceBusMessage livre que podem ser usadas para passar metadados associados ao durante as operações do ServiceBusMessage Barramento de Serviço.
BinaryData	getBody() Obtém o conteúdo real encapsulado pelo ServiceBusMessage.
String	getContentType() Obtém o tipo de conteúdo da mensagem.
String	getCorrelationId() Obtém um identificador de correlação.
String	getMessageId() Obtém a ID da mensagem.
String	getPartitionKey() Obtém a chave de partição para enviar uma mensagem para uma entidade particionada.
AmqpAnnotatedMessage	getRawAmqpMessage() Obtém o AmqpAnnotatedMessage.
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.
String	getSessionId() Obtém o identificador de sessão para uma entidade com reconhecimento de sessão.
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".
ServiceBusMessage	setContentType(String contentType) Define o tipo de conteúdo do ServiceBusMessage.
ServiceBusMessage	setCorrelationId(String correlationId) Define um identificador de correlação.
ServiceBusMessage	setMessageId(String messageId) Define a ID da mensagem.
ServiceBusMessage	setPartitionKey(String partitionKey) Define uma chave de partição para enviar uma mensagem para uma entidade particionada
ServiceBusMessage	setReplyTo(String replyTo) Define o endereço de uma entidade para a qual enviar respostas.
ServiceBusMessage	setReplyToSessionId(String replyToSessionId) Obtém ou define um identificador de sessão que aumenta o getReplyTo() endereço.
ServiceBusMessage	setScheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime) Define a hora de enfileiramento agendada desta mensagem.
ServiceBusMessage	setSessionId(String sessionId) Define o identificador de sessão para uma entidade com reconhecimento de sessão.
ServiceBusMessage	setSubject(String subject) Define o assunto para a mensagem.
ServiceBusMessage	setTimeToLive(Duration timeToLive) Define a duração do tempo antes que essa mensagem expire.
ServiceBusMessage	setTo(String to) Define o endereço "para".

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

ServiceBusMessage

public ServiceBusMessage(byte[] body)

Cria um ServiceBusMessage com o corpo da matriz de bytes fornecido.

Parameters:

body - O conteúdo da mensagem do Barramento de serviço.

ServiceBusMessage

public ServiceBusMessage(AmqpMessageBody amqpMessageBody)

Esse construtor fornece uma maneira fácil de criar ServiceBusMessage com o corpo da mensagem como tipos SEQUENCE de dados AMQP e VALUE. No caso de SEQUENCE, tt dá suporte ao envio e recebimento de apenas uma sequência AMQP no momento. Se você estiver enviando uma mensagem com uma matriz de bytes ou dados de cadeia de caracteres, você também poderá usar outro construtor.

Parameters:

amqpMessageBody - corpo da mensagem amqp.

ServiceBusMessage

public ServiceBusMessage(BinaryData body)

Cria um ServiceBusMessage que contém o body. O BinaryData fornece várias API de conveniência que representam a matriz de bytes. Ele também fornece uma maneira de serializar Object em BinaryData.

Parameters:

body - Os dados a serem definidos para este ServiceBusMessage.

ServiceBusMessage

public ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)

Cria um ServiceBusMessage usando propriedades de receivedMessage. Normalmente, isso é usado quando um ServiceBusReceivedMessage precisa ser enviado para outra entidade.

Parameters:

receivedMessage - A mensagem recebida da qual criar uma nova mensagem.

ServiceBusMessage

public ServiceBusMessage(String body)

Cria um ServiceBusMessage com um UTF-8 corpo codificado.

Parameters:

body - O conteúdo da mensagem do Barramento de Serviço.

Detalhes do método

addContext

public ServiceBusMessage addContext(String key, Object value)

Adiciona um novo par de valores de chave ao contexto existente em Mensagem.

Parameters:

key - A chave para este objeto de contexto

value - O valor desse objeto de contexto.

Returns:

O ServiceBusMessage atualizado.

getApplicationProperties

public Map getApplicationProperties()

Obtém o conjunto de propriedades de forma ServiceBusMessage livre que podem ser usadas para passar metadados associados ao durante as operações do ServiceBusMessage Barramento de Serviço. Um caso de uso comum para getApplicationProperties() é 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 ServiceBusMessage.

getBody

public BinaryData getBody()

Obtém o conteúdo real encapsulado pelo ServiceBusMessage.

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 tipo de conteúdo do ServiceBusMessage.

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.

getMessageId

public String getMessageId()

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

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()

Obtém o AmqpAnnotatedMessage.

Returns:

A mensagem AMQP bruta.

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 as getReplyTo() informações e especifica quais sessionId devem ser definidas para a resposta quando enviadas para a entidade de resposta.

Returns:

O getReplyToGroupId valor da propriedade dessa 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

getSessionId

public String getSessionId()

Obtém o identificador de sessão para uma entidade com reconhecimento de sessão.

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 ServiceBusMessage.

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 instante 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

setContentType

public ServiceBusMessage setContentType(String contentType)

Define o tipo de conteúdo do ServiceBusMessage.

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

Parameters:

contentType - RFC2045 descritor content-type da mensagem.

Returns:

O ServiceBusMessage atualizado.

setCorrelationId

public ServiceBusMessage setCorrelationId(String correlationId)

Define um identificador de correlação.

Parameters:

correlationId - ID de correlação desta mensagem

Returns:

O ServiceBusMessage atualizado.

setMessageId

public ServiceBusMessage setMessageId(String messageId)

Define a ID da mensagem.

Parameters:

messageId - A ID da mensagem a ser definida.

Returns:

O ServiceBusMessage atualizado.

setPartitionKey

public ServiceBusMessage setPartitionKey(String partitionKey)

Define uma chave de partição para enviar uma mensagem para uma entidade particionada

Parameters:

partitionKey - A chave de partição dessa mensagem.

Returns:

O ServiceBusMessage atualizado.

setReplyTo

public ServiceBusMessage setReplyTo(String replyTo)

Define o endereço de uma entidade para a qual enviar respostas.

Parameters:

replyTo - Valor da propriedade ReplyTo desta mensagem

Returns:

O ServiceBusMessage atualizado.

setReplyToSessionId

public ServiceBusMessage setReplyToSessionId(String replyToSessionId)

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

Parameters:

replyToSessionId - O valor da propriedade ReplyToGroupId dessa mensagem.

Returns:

O ServiceBusMessage atualizado.

setScheduledEnqueueTime

public ServiceBusMessage setScheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime)

Define a hora de enfileiramento agendada desta mensagem. Um null não será definido. Se esse valor precisar ser desconjunto, ele poderá ser feito por meio da remoção de valor do uso da AmqpAnnotatedMessage#getMessageAnnotations() chave AmqpMessageConstant#SCHEDULED_ENQUEUE_UTC_TIME_NAME.

Parameters:

scheduledEnqueueTime - o datetime no qual essa mensagem deve ser enfileirada em Barramento de Serviço do Azure.

Returns:

O ServiceBusMessage atualizado.

setSessionId

public ServiceBusMessage setSessionId(String sessionId)

Define o identificador de sessão para uma entidade com reconhecimento de sessão.

Parameters:

sessionId - O identificador de sessão a ser definido.

Returns:

O ServiceBusMessage atualizado.

setSubject

public ServiceBusMessage setSubject(String subject)

Define o assunto da mensagem.

Parameters:

subject - O assunto específico do aplicativo.

Returns:

O objeto atualizado ServiceBusMessage.

setTimeToLive

public ServiceBusMessage setTimeToLive(Duration timeToLive)

Define a duração do tempo antes que essa mensagem expire.

Parameters:

timeToLive - Duração da vida útil desta mensagem

Returns:

O ServiceBusMessage atualizado.

setTo

public ServiceBusMessage setTo(String to)

Define 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 controlados por regras para indicar o destino lógico pretendido da mensagem.

Parameters:

to - Para o valor da propriedade desta mensagem.

Returns:

O ServiceBusMessage atualizado.