ServiceBusMessage Clase

Paquete:

com.azure.messaging.servicebus

Artefacto Maven:

com.azure:azure-messaging-servicebus:7.17.0

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

public class ServiceBusMessage

Estructura de datos que encapsula el mensaje que se envía a Service Bus. La estructura del mensaje se describe en detalle en la documentación del producto.

Resumen del constructor

Constructor	Description
ServiceBusMessage(byte[] body)	Crea un objeto con un ServiceBusMessage cuerpo de matriz de bytes determinado.
ServiceBusMessage(AmqpMessageBody amqpMessageBody)	Este constructor proporciona una manera fácil de crear ServiceBusMessage con el cuerpo del mensaje como tipos SEQUENCE de datos AMQP y VALUE.
ServiceBusMessage(BinaryData body)	Crea un objeto ServiceBusMessage que contiene . bodyBinaryData proporciona varias API de conveniencia que representan la matriz de bytes.
ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)	Crea un ServiceBusMessage objeto using a partir de receivedMessage.
ServiceBusMessage(String body)	Crea un ServiceBusMessage objeto con un UTF-8 cuerpo codificado.

Resumen del método

Modificador y tipo	Método y descripción
ServiceBusMessage	addContext(String key, Object value) Agrega un nuevo par de valores de clave al contexto existente en Message.
Map<String,Object>	getApplicationProperties() Obtiene el conjunto de propiedades de forma ServiceBusMessage libre que se pueden usar para pasar metadatos asociados a durante las ServiceBusMessage operaciones de Service Bus.
BinaryData	getBody() Obtiene la carga real ajustada por .ServiceBusMessage
String	getContentType() Obtiene el tipo de contenido del mensaje.
String	getCorrelationId() Obtiene un identificador de correlación.
String	getMessageId() Obtiene el identificador del mensaje.
String	getPartitionKey() Obtiene la clave de partición para enviar un mensaje a una entidad con particiones.
AmqpAnnotatedMessage	getRawAmqpMessage() Obtiene la estructura AmqpAnnotatedMessage.
String	getReplyTo() Obtiene la dirección de una entidad a la que se van a enviar respuestas.
String	getReplyToSessionId() Obtiene o establece un identificador de sesión que aumenta la getReplyTo() dirección.
OffsetDateTime	getScheduledEnqueueTime() Obtiene la hora de puesta en cola programada de este mensaje.
String	getSessionId() Obtiene el identificador de sesión de una entidad compatible con sesión.
String	getSubject() Obtiene el asunto del mensaje.
Duration	getTimeToLive() Obtiene la duración antes de que expire este mensaje.
String	getTo() Obtiene la dirección "to".
ServiceBusMessage	setContentType(String contentType) Establece el tipo de contenido de ServiceBusMessage.
ServiceBusMessage	setCorrelationId(String correlationId) Establece un identificador de correlación.
ServiceBusMessage	setMessageId(String messageId) Establece el identificador del mensaje.
ServiceBusMessage	setPartitionKey(String partitionKey) Establece una clave de partición para enviar un mensaje a una entidad con particiones
ServiceBusMessage	setReplyTo(String replyTo) Establece la dirección de una entidad a la que se van a enviar respuestas.
ServiceBusMessage	setReplyToSessionId(String replyToSessionId) Obtiene o establece un identificador de sesión que aumenta la getReplyTo() dirección.
ServiceBusMessage	setScheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime) Establece la hora de puesta en cola programada de este mensaje.
ServiceBusMessage	setSessionId(String sessionId) Establece el identificador de sesión de una entidad compatible con sesión.
ServiceBusMessage	setSubject(String subject) Establece el asunto del mensaje.
ServiceBusMessage	setTimeToLive(Duration timeToLive) Establece la duración del tiempo antes de que expire este mensaje.
ServiceBusMessage	setTo(String to) Establece la dirección "to".

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

ServiceBusMessage

public ServiceBusMessage(byte[] body)

Crea un objeto con un ServiceBusMessage cuerpo de matriz de bytes determinado.

Parameters:

body - El contenido del mensaje de Service Bus.

ServiceBusMessage

public ServiceBusMessage(AmqpMessageBody amqpMessageBody)

Este constructor proporciona una manera fácil de crear ServiceBusMessage con el cuerpo del mensaje como tipos SEQUENCE de datos AMQP y VALUE. En el caso de SEQUENCE, tt admite el envío y la recepción de solo una secuencia amQP en la actualidad. Si va a enviar un mensaje con una sola matriz de bytes o datos de cadena, también puede usar otro constructor.

Parameters:

amqpMessageBody - cuerpo del mensaje amqp.

ServiceBusMessage

public ServiceBusMessage(BinaryData body)

Crea un objeto ServiceBusMessage que contiene . bodyBinaryData proporciona varias API de conveniencia que representan la matriz de bytes. También proporciona una manera de serializar Object en BinaryData.

Parameters:

body - Los datos que se van a establecer para este .ServiceBusMessage

ServiceBusMessage

public ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)

Crea un ServiceBusMessage objeto using a partir de receivedMessage. Normalmente se usa cuando ServiceBusReceivedMessage es necesario enviar un elemento a otra entidad.

Parameters:

receivedMessage - Mensaje recibido desde el que se va a crear un nuevo mensaje.

ServiceBusMessage

public ServiceBusMessage(String body)

Crea un ServiceBusMessage objeto con un UTF-8 cuerpo codificado.

Parameters:

body - El contenido del mensaje de Service Bus.

Detalles del método

addContext

public ServiceBusMessage addContext(String key, Object value)

Agrega un nuevo par de valores de clave al contexto existente en Message.

Parameters:

key - Clave para este objeto de contexto

value - Valor de este objeto de contexto.

Returns:

ServiceBusMessage actualizado.

getApplicationProperties

public Map getApplicationProperties()

Obtiene el conjunto de propiedades de forma ServiceBusMessage libre que se pueden usar para pasar metadatos asociados a durante las ServiceBusMessage operaciones de Service Bus. Un caso de uso común para getApplicationProperties() es asociar sugerencias de serialización para como getBody() ayuda a los consumidores que desean deserializar los datos binarios.

Returns:

Propiedades de la aplicación asociadas a este .ServiceBusMessage

getBody

public BinaryData getBody()

Obtiene la carga real ajustada por .ServiceBusMessage

El BinaryData encapsula la matriz de bytes y es una abstracción de muchas maneras diferentes en que se puede representar. Proporciona API útiles para serializar o deserializar el objeto.

Si los medios para deserializar los datos sin procesar no son evidentes para los consumidores, una técnica común consiste en usar getApplicationProperties() al crear el evento para asociar sugerencias de serialización como ayuda a los consumidores que deseen deserializar los datos binarios.

Returns:

Datos binarios que representan la carga útil.

getContentType

public String getContentType()

Obtiene el tipo de contenido del mensaje.

Opcionalmente, describe la carga del mensaje, con un descriptor que sigue el formato de RFC2045, sección 5, por ejemplo, "application/json".

Returns:

Tipo de contenido del ServiceBusMessage.

getCorrelationId

public String getCorrelationId()

Obtiene un identificador de correlación.

Permite que una aplicación especifique un contexto del mensaje con fines de correlación, por ejemplo, que refleje el MessageId de un mensaje que se ha respondido.

Returns:

Identificador de correlación de este mensaje.

getMessageId

public String getMessageId()

Obtiene el identificador del mensaje.

El identificador del mensaje es un valor definido por la aplicación que identifica de forma única el mensaje y su carga. El identificador es una cadena de forma libre y puede reflejar un GUID o un identificador que se deriva del contexto de la aplicación. Si está habilitada, la característica de detección de duplicados identifica y quita los envíos de segundo y posteriores de mensajes con el mismo messageId.

Returns:

Identificador de .ServiceBusMessage

getPartitionKey

public String getPartitionKey()

Obtiene la clave de partición para enviar un mensaje a una entidad con particiones.

En el caso de entidades con particiones, la configuración de este valor permite asignar mensajes relacionados a la misma partición interna, por lo que el orden de la secuencia de envío se registra correctamente. La partición la elige una función hash sobre este valor y no se puede seleccionar directamente. En el caso de las entidades compatibles con la sesión, la getSessionId() propiedad invalida este valor.

Returns:

Clave de partición de este mensaje.

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

Obtiene la estructura AmqpAnnotatedMessage.

Returns:

Mensaje AMQP sin formato.

getReplyTo

public String getReplyTo()

Obtiene la dirección de una entidad a la que se van a enviar respuestas.

Este valor opcional y definido por la aplicación es un método estándar de expresar una ruta de acceso de respuesta al receptor del mensaje. Cuando un remitente espera una respuesta, establece el valor en la ruta de acceso absoluta o relativa de la cola o tema al que espera que se envíe la respuesta.

Returns:

Valor de la propiedad ReplyTo de este mensaje

getReplyToSessionId

public String getReplyToSessionId()

Obtiene o establece un identificador de sesión que aumenta la getReplyTo() dirección.

Este valor aumenta la getReplyTo() información y especifica qué sessionId se debe establecer para la respuesta cuando se envía a la entidad de respuesta.

Returns:

Valor getReplyToGroupId de propiedad de este mensaje.

getScheduledEnqueueTime

public OffsetDateTime getScheduledEnqueueTime()

Obtiene la hora de puesta en cola programada de este mensaje.

Este valor se usa para la disponibilidad diferida de mensajes. El mensaje se agrega de forma segura a la cola, pero no se considera activo y, por lo tanto, no se puede recuperar hasta la hora de puesta en cola programada. Tenga en cuenta que es posible que el mensaje no se active (en cola) en la fecha y hora exacta especificada; el tiempo de activación real depende de la carga de trabajo de la cola y su estado.

Returns:

fecha y hora en la que se pondrá en cola el mensaje en Azure Service Bus

getSessionId

public String getSessionId()

Obtiene el identificador de sesión de una entidad compatible con sesión.

Para entidades que tienen en cuenta la sesión, este valor definido por la aplicación especifica la afiliación de sesión del mensaje. Los mensajes con el mismo identificador de sesión están sujetas al bloqueo de resumen y habilitan el procesamiento en orden exacto y la desmultiplexación. Para las entidades que no tienen en cuenta la sesión, este valor se omite. Consulte Sesiones de mensajes.

Returns:

Identificador de sesión de ServiceBusMessage.

getSubject

public String getSubject()

Obtiene el asunto del mensaje.

Esta propiedad permite a la aplicación indicar el propósito del mensaje al receptor de modo estandarizado, similar a una línea de asunto de correo electrónico. La propiedad AMQP asignada es "subject".

Returns:

Asunto del mensaje.

getTimeToLive

public Duration getTimeToLive()

Obtiene la duración antes de que expire este mensaje.

Este valor es la duración relativa después de la cual expira el mensaje, comenzando desde el instante en que el agente ha aceptado y almacenado el mensaje, como se captura en getScheduledEnqueueTime(). Cuando no se establece explícitamente, el valor asumido es defaultTimeToLive establecido para la cola o el tema respectivos. El valor de TimeToLive de nivel de mensaje no puede ser mayor que la configuración de DefaultTimeToLive de la entidad y se ajusta automáticamente si existe.

Returns:

Período de vida de este mensaje

getTo

public String getTo()

Obtiene la dirección "to".

Esta propiedad está reservada para un uso futuro en escenarios de enrutamiento y actualmente la omite el propio agente. Las aplicaciones pueden usar este valor en escenarios de encadenamiento automático controlado por reglas para indicar el destino lógico previsto del mensaje.

Returns:

Valor de la propiedad "To" de este mensaje

setContentType

public ServiceBusMessage setContentType(String contentType)

Establece el tipo de contenido de ServiceBusMessage.

Opcionalmente, describe la carga del mensaje, con un descriptor que sigue el formato de RFC2045, sección 5, por ejemplo, "application/json".

Parameters:

contentType - RFC2045 descriptor Content-Type del mensaje.

Returns:

ServiceBusMessage actualizado.

setCorrelationId

public ServiceBusMessage setCorrelationId(String correlationId)

Establece un identificador de correlación.

Parameters:

correlationId - id. de correlación de este mensaje

Returns:

ServiceBusMessage actualizado.

setMessageId

public ServiceBusMessage setMessageId(String messageId)

Establece el identificador del mensaje.

Parameters:

messageId - Identificador del mensaje que se va a establecer.

Returns:

ServiceBusMessage actualizado.

setPartitionKey

public ServiceBusMessage setPartitionKey(String partitionKey)

Establece una clave de partición para enviar un mensaje a una entidad con particiones

Parameters:

partitionKey - Clave de partición de este mensaje.

Returns:

ServiceBusMessage actualizado.

setReplyTo

public ServiceBusMessage setReplyTo(String replyTo)

Establece la dirección de una entidad a la que se van a enviar respuestas.

Parameters:

replyTo - Valor de la propiedad ReplyTo de este mensaje

Returns:

ServiceBusMessage actualizado.

setReplyToSessionId

public ServiceBusMessage setReplyToSessionId(String replyToSessionId)

Obtiene o establece un identificador de sesión que aumenta la getReplyTo() dirección.

Parameters:

replyToSessionId - Valor de la propiedad ReplyToGroupId de este mensaje.

Returns:

ServiceBusMessage actualizado.

setScheduledEnqueueTime

public ServiceBusMessage setScheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime)

Establece la hora de puesta en cola programada de este mensaje. null No se establecerá . Si este valor debe desconfigurarse, se podría realizar mediante la eliminación de valores de AmqpAnnotatedMessage#getMessageAnnotations() mediante la clave AmqpMessageConstant#SCHEDULED_ENQUEUE_UTC_TIME_NAME.

Parameters:

scheduledEnqueueTime - fecha y hora en la que se debe poner en cola este mensaje en Azure Service Bus.

Returns:

ServiceBusMessage actualizado.

setSessionId

public ServiceBusMessage setSessionId(String sessionId)

Establece el identificador de sesión de una entidad compatible con sesión.

Parameters:

sessionId - Identificador de sesión que se va a establecer.

Returns:

ServiceBusMessage actualizado.

setSubject

public ServiceBusMessage setSubject(String subject)

Establece el asunto del mensaje.

Parameters:

subject - Asunto específico de la aplicación.

Returns:

Objeto ServiceBusMessage actualizado.

setTimeToLive

public ServiceBusMessage setTimeToLive(Duration timeToLive)

Establece la duración del tiempo antes de que expire este mensaje.

Parameters:

timeToLive - Período de vida de este mensaje

Returns:

ServiceBusMessage actualizado.

setTo

public ServiceBusMessage setTo(String to)

Establece la dirección "to".

Esta propiedad está reservada para un uso futuro en escenarios de enrutamiento y actualmente la omite el propio agente. Las aplicaciones pueden usar este valor en escenarios de encadenamiento automático de reenvío automático controlado por reglas para indicar el destino lógico previsto del mensaje.

Parameters:

to - Para el valor de propiedad de este mensaje.

Returns:

ServiceBusMessage actualizado.