ServiceBusReceivedMessage Clase
- java.
lang. Object - com.
azure. messaging. servicebus. ServiceBusReceivedMessage
- com.
public final class ServiceBusReceivedMessage
Estructura de datos que encapsula el mensaje recibido de Service Bus. La estructura del mensaje se describe en detalle en la documentación del producto.
Resumen del método
| Modificador y tipo | Método y descripción |
|---|---|
| Map<String,Object> |
getApplicationProperties()
Obtiene el conjunto de propiedades de forma ServiceBusReceivedMessage libre que se pueden usar para pasar metadatos asociados a ServiceBusReceivedMessage durante las operaciones de Service Bus. |
|
Binary |
getBody()
Obtiene la carga encapsulada por .ServiceBusReceivedMessage |
| String |
getContentType()
Obtiene el tipo de contenido del mensaje. |
| String |
getCorrelationId()
Obtiene un identificador de correlación. |
| String |
getDeadLetterErrorDescription()
Obtiene la descripción de un mensaje que se ha fallido. |
| String |
getDeadLetterReason()
Obtiene el motivo por el que se ha escrito un mensaje fallido. |
| String |
getDeadLetterSource()
Obtiene el nombre de la cola o suscripción en la que se puso en cola este mensaje antes de que se le enviaran mensajes fallidos. |
| long |
getDeliveryCount()
Obtiene el número de veces que este mensaje se entregó a los clientes. |
| long |
getEnqueuedSequenceNumber()
Obtiene el número de secuencia en cola asignado a un mensaje por Service Bus. |
|
Offset |
getEnqueuedTime()
Obtiene la fecha y hora en la que se puso en cola este mensaje en Azure Service Bus. |
|
Offset |
getExpiresAt()
Obtiene la fecha y hora en la que expirará este mensaje. |
| String |
getLockToken()
Obtiene el token de bloqueo del mensaje actual. |
|
Offset |
getLockedUntil()
Obtiene la fecha y hora en la que expira el bloqueo de este mensaje. |
| String |
getMessageId()
Obtiene el identificador del mensaje. |
| String |
getPartitionKey()
Obtiene la clave de partición para enviar un mensaje a una entidad con particiones. |
|
Amqp |
getRawAmqpMessage()
Representación del mensaje tal y como se define en el protocolo AMQP. |
| 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. |
|
Offset |
getScheduledEnqueueTime()
Obtiene la hora de puesta en cola programada de este mensaje. |
| long |
getSequenceNumber()
Obtiene el número único asignado a un mensaje por Service Bus. |
| String |
getSessionId()
Obtiene el identificador de sesión del mensaje. |
|
Service |
getState()
Obtiene el estado del mensaje. |
| 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". |
Métodos heredados de java.lang.Object
Detalles del método
getApplicationProperties
public Map
Obtiene el conjunto de propiedades de forma ServiceBusReceivedMessage libre que se pueden usar para pasar metadatos asociados a ServiceBusReceivedMessage durante las operaciones de Service Bus. Un caso de uso común para properties() es asociar sugerencias de serialización para como getBody() ayuda a los consumidores que desean deserializar los datos binarios.
Returns:
getBody
public BinaryData getBody()
Obtiene la carga encapsulada por .ServiceBusReceivedMessage
La BinaryData matriz de bytes encapsula y es una abstracción en muchas formas diferentes de representarse. 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 al crear el evento para asociar sugerencias de getApplicationProperties() serialización como ayuda a los consumidores que desean deserializar los datos binarios.
Returns:
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:
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:
getDeadLetterErrorDescription
public String getDeadLetterErrorDescription()
Obtiene la descripción de un mensaje que se ha fallido.
Returns:
null Lo contrario.getDeadLetterReason
public String getDeadLetterReason()
Obtiene el motivo por el que se ha escrito un mensaje fallido.
Returns:
null Lo contrario.getDeadLetterSource
public String getDeadLetterSource()
Obtiene el nombre de la cola o suscripción en la que se puso en cola este mensaje antes de que se le enviaran mensajes fallidos.
Este valor solo se establece en mensajes fallidos y, posteriormente, reenviados automáticamente desde la cola de mensajes fallidos a otra entidad.
Returns:
null Lo contrario.getDeliveryCount
public long getDeliveryCount()
Obtiene el número de veces que este mensaje se entregó a los clientes.
El recuento se incrementa cuando expira un bloqueo del mensaje o si el mensaje lo abandona explícitamente el receptor.
Returns:
getEnqueuedSequenceNumber
public long getEnqueuedSequenceNumber()
Obtiene el número de secuencia en cola asignado a un mensaje por Service Bus.
El número de secuencia es un entero de 64 bits único asignado primero a un mensaje, ya que se acepta en su punto de envío original.
Returns:
getEnqueuedTime
public OffsetDateTime getEnqueuedTime()
Obtiene la fecha y hora en la que se puso en cola este mensaje en Azure Service Bus.
Fecha y hora UTC en la que se ha aceptado y almacenado el mensaje en la entidad. Para los mensajes programados, esto refleja la hora en que se activó el mensaje. Este valor puede usarse como un indicador de hora de llegada autoritativo y neutro cuando el receptor no desea confiar en el reloj del remitente.
Returns:
getExpiresAt
public OffsetDateTime getExpiresAt()
Obtiene la fecha y hora en la que expirará este mensaje.
El valor es la fecha y hora UTC para cuando el mensaje está programado para su eliminación y ya no estará disponible para la recuperación de la entidad. La expiración se controla mediante la getTimeToLive() propiedad . Esta propiedad se calcula desde getEnqueuedTime() más getTimeToLive().
Returns:
getLockToken
public String getLockToken()
Obtiene el token de bloqueo del mensaje actual.
El token de bloqueo es una referencia al bloqueo que mantiene el agente en PEEK_LOCK modo. Los bloqueos se usan para liquidar explícitamente los mensajes, como se explica en la documentación del producto. El token también se puede usar para anclar el bloqueo permanentemente a través de la API de aplazamiento y sacar el mensaje del flujo de estado de entrega normal. Esta propiedad es de sólo lectura.
Returns:
null para los mensajes recuperados a través del RECEIVE_AND_DELETE modo .getLockedUntil
public OffsetDateTime getLockedUntil()
Obtiene la fecha y hora en la que expira el bloqueo de este mensaje.
En el caso de los mensajes recuperados bajo un bloqueo (modo de recepción peek-lock, no preentrada), esta propiedad refleja la fecha y hora UTC hasta la que el mensaje se mantiene bloqueado en la cola o suscripción. Cuando expira el bloqueo, getDeliveryCount() se incrementa y el mensaje vuelve a estar disponible para su recuperación. Esta propiedad es de sólo lectura.
Returns:
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:
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:
getRawAmqpMessage
public AmqpAnnotatedMessage getRawAmqpMessage()
Representación del mensaje tal y como se define en el protocolo AMQP.
Returns:
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:
getReplyToSessionId
public String getReplyToSessionId()
Obtiene o establece un identificador de sesión que aumenta la getReplyTo() dirección.
Este valor aumenta la información de ReplyTo y especifica qué propiedad SessionId debe establecerse para la respuesta cuando se envió a la entidad de respuesta.
Returns:
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:
getSequenceNumber
public long getSequenceNumber()
Obtiene el número único asignado a un mensaje por Service Bus.
El número de secuencia es un entero de 64 bits único asignado a un mensaje cuando el agente lo acepta y lo almacena, y funciona como su verdadero identificador. Para entidades con particiones, los 16 bits superiores reflejan el identificador de la partición. Los números de secuencia aumentan de forma continuada. Vuelven a 0 cuando se agota el intervalo de 48-64 bits. Esta propiedad es de solo lectura.
Returns:
getSessionId
public String getSessionId()
Obtiene el identificador de sesión del mensaje.
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:
getState
public ServiceBusMessageState getState()
Obtiene el estado del mensaje. El estado del mensaje puede ser Activo, Diferido o Programado. Los mensajes diferidos tienen el estado Diferido, los mensajes programados tienen el estado Scheduled, todos los demás mensajes tienen el estado Activo.
Returns:
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:
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, a partir de la fecha y hora 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:
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:
Se aplica a
Azure SDK for Java