ServiceBusReceivedMessage Classe
- java.
lang. Object - com.
azure. messaging. servicebus. ServiceBusReceivedMessage
- com.
public final class ServiceBusReceivedMessage
Structure de données qui encapsule le message reçu de Service Bus. La structure du message est abordée en détail dans la documentation du produit.
Résumé de la méthode
| Modificateur et type | Méthode et description |
|---|---|
| Map<String,Object> |
getApplicationProperties()
Obtient l’ensemble de propriétés de forme ServiceBusReceivedMessage libre qui peuvent être utilisées pour passer les métadonnées associées au pendant les ServiceBusReceivedMessage opérations Service Bus. |
|
Binary |
getBody()
Obtient la charge utile encapsulée par .ServiceBusReceivedMessage |
| String |
getContentType()
Obtient le type de contenu du message. |
| String |
getCorrelationId()
Obtient un identificateur de corrélation. |
| String |
getDeadLetterErrorDescription()
Obtient la description d’un message qui a été en lettres mortes. |
| String |
getDeadLetterReason()
Obtient la raison pour laquelle un message a été en lettres mortes. |
| String |
getDeadLetterSource()
Obtient le nom de la file d’attente ou de l’abonnement sur lequel ce message a été mis en file d’attente, avant qu’il ne soit lettre morte. |
| long |
getDeliveryCount()
Obtient le nombre de fois où ce message a été remis aux clients. |
| long |
getEnqueuedSequenceNumber()
Obtient le numéro de séquence en file d’attente attribué à un message par Service Bus. |
|
Offset |
getEnqueuedTime()
Obtient la dateheure à laquelle ce message a été mis en file d’attente dans Azure Service Bus. |
|
Offset |
getExpiresAt()
Obtient la dateheure à laquelle ce message expire. |
| String |
getLockToken()
Obtient le jeton de verrouillage du message actuel. |
|
Offset |
getLockedUntil()
Obtient la dateheure à laquelle le verrou de ce message expire. |
| String |
getMessageId()
Obtient l’identificateur du message. |
| String |
getPartitionKey()
Obtient la clé de partition pour l’envoi d’un message à une entité partitionnée. |
|
Amqp |
getRawAmqpMessage()
Représentation du message telle que définie par le protocole AMQP. |
| String |
getReplyTo()
Obtient l’adresse d’une entité à laquelle envoyer des réponses. |
| String |
getReplyToSessionId()
Obtient ou définit un identificateur de session qui augmente l’adresse getReplyTo() . |
|
Offset |
getScheduledEnqueueTime()
Obtient l’heure d’attente planifiée de ce message. |
| long |
getSequenceNumber()
Obtient le numéro unique attribué à un message par Service Bus. |
| String |
getSessionId()
Obtient l’ID de session du message. |
|
Service |
getState()
Obtient l’état du message. |
| String |
getSubject()
Obtient l’objet du message. |
| Duration |
getTimeToLive()
Obtient la durée avant l’expiration de ce message. |
| String |
getTo()
Obtient l’adresse « à ». |
Méthodes héritées de java.lang.Object
Détails de la méthode
getApplicationProperties
public Map
Obtient l’ensemble de propriétés de forme ServiceBusReceivedMessage libre qui peuvent être utilisées pour passer les métadonnées associées au pendant les ServiceBusReceivedMessage opérations Service Bus. Un cas d’usage courant pour properties() est d’associer des conseils de sérialisation pour le getBody() comme une aide aux consommateurs qui souhaitent désérialiser les données binaires.
Returns:
getBody
public BinaryData getBody()
Obtient la charge utile encapsulée par .ServiceBusReceivedMessage
Le BinaryData tableau d’octets encapsule et est une abstraction sur de nombreuses façons différentes de le représenter. Il fournit des API pratiques pour sérialiser/désérialiser l’objet.
Si les moyens de désérialisation des données brutes ne sont pas apparents pour les consommateurs, une technique courante consiste à utiliser lors de la création de getApplicationProperties() l’événement, à associer des indicateurs de sérialisation comme aide aux consommateurs qui souhaitent désérialiser les données binaires.
Returns:
getContentType
public String getContentType()
Obtient le type de contenu du message.
Décrit éventuellement la charge utile du message, avec un descripteur suivant le format de RFC2045, section 5, par exemple « application/json ».
Returns:
getCorrelationId
public String getCorrelationId()
Obtient un identificateur de corrélation.
Cette propriété permet à une application de spécifier un contexte pour le message à des fins de corrélation, qui reflète par exemple l’élément MessageId d’un message recevant une réponse.
Returns:
getDeadLetterErrorDescription
public String getDeadLetterErrorDescription()
Obtient la description d’un message qui a été en lettres mortes.
Returns:
null Sinon.getDeadLetterReason
public String getDeadLetterReason()
Obtient la raison pour laquelle un message a été en lettres mortes.
Returns:
null Sinon.getDeadLetterSource
public String getDeadLetterSource()
Obtient le nom de la file d’attente ou de l’abonnement sur lequel ce message a été mis en file d’attente, avant qu’il ne soit lettre morte.
Cette valeur est définie uniquement dans les messages qui ont été en lettres mortes et transférés automatiquement par la suite de la file d’attente de lettres mortes vers une autre entité.
Returns:
null Sinon.getDeliveryCount
public long getDeliveryCount()
Obtient le nombre de fois où ce message a été remis aux clients.
Ce nombre est incrémenté lorsque le verrouillage d’un message arrive à expiration, ou que le message est explicitement abandonné par le destinataire.
Returns:
getEnqueuedSequenceNumber
public long getEnqueuedSequenceNumber()
Obtient le numéro de séquence en file d’attente attribué à un message par Service Bus.
Le numéro de séquence est un entier unique 64 bits attribué pour la première fois à un message, car il est accepté à son point d’origine de soumission.
Returns:
getEnqueuedTime
public OffsetDateTime getEnqueuedTime()
Obtient la dateheure à laquelle ce message a été mis en file d’attente dans Azure Service Bus.
Date utc heure à laquelle le message a été accepté et stocké dans l’entité. Pour les messages planifiés, cela reflète l’heure à laquelle le message a été activé. Cette valeur peut faire office d’indicateur d’heure d’arrivée de référence et neutre lorsque le destinataire ne souhaite pas se fier à l’horloge de l’expéditeur.
Returns:
getExpiresAt
public OffsetDateTime getExpiresAt()
Obtient la dateheure à laquelle ce message expire.
La valeur est la dateheure UTC pour le moment où le message est planifié pour la suppression et ne sera plus disponible pour la récupération à partir de l’entité. L’expiration est contrôlée par la getTimeToLive() propriété . Cette propriété est calculée à partir de getEnqueuedTime() plus getTimeToLive().
Returns:
getLockToken
public String getLockToken()
Obtient le jeton de verrouillage du message actuel.
Le jeton de verrou est une référence au verrou qui est détenu par le répartiteur en PEEK_LOCK mode. Les verrous sont utilisés pour régler explicitement les messages, comme expliqué dans la documentation du produit. Le jeton peut également être utilisé pour épingler définitivement le verrou via l’API Deferral et sortir le message du flux d’état de remise normal. Cette propriété est en lecture seule.
Returns:
null pour les messages récupérés via le RECEIVE_AND_DELETE mode.getLockedUntil
public OffsetDateTime getLockedUntil()
Obtient la dateheure à laquelle le verrou de ce message expire.
Pour les messages récupérés sous un verrou (mode de réception peek-lock, non prédéfini), cette propriété reflète la datetime UTC jusqu’à laquelle le message est verrouillé dans la file d’attente/l’abonnement. Lorsque le verrou expire, le getDeliveryCount() est incrémenté et le message est à nouveau disponible pour récupération. Cette propriété est en lecture seule.
Returns:
getMessageId
public String getMessageId()
Obtient l’identificateur du message.
L’identificateur de message est une valeur définie par l’application qui identifie de manière unique le message et sa charge utile. Cet identificateur est une chaîne à structure libre et peut refléter un identificateur global unique (GUID) ou un identificateur dérivé du contexte de l’application. Si cette option est activée, la fonctionnalité de détection dupliquée identifie et supprime les envois secondaires et ultérieurs de messages avec le même messageId.
Returns:
getPartitionKey
public String getPartitionKey()
Obtient la clé de partition pour l’envoi d’un message à une entité partitionnée.
Dans le cas des entités partitionnées, la définition de cette valeur permet d’attribuer des messages associés à la même partition interne, afin que l’ordre de séquence d’envoi soit correctement enregistré. La partition est choisie par une fonction de hachage prioritaire sur cette valeur et ne peut pas être sélectionnée directement. Pour les entités prenant en charge la session, la getSessionId() propriété remplace cette valeur.
Returns:
getRawAmqpMessage
public AmqpAnnotatedMessage getRawAmqpMessage()
Représentation du message telle que définie par le protocole AMQP.
Returns:
getReplyTo
public String getReplyTo()
Obtient l’adresse d’une entité à laquelle envoyer des réponses.
Cette valeur facultative et définie par l’application est un moyen standard d’exprimer un chemin d’accès de réponse à l’intention du destinataire du message. Lorsqu’un expéditeur attend une réponse, cette propriété définit cette valeur sur le chemin d’accès absolu ou relatif de la file d’attente ou de la rubrique auxquelles la réponse doit être envoyée.
Returns:
getReplyToSessionId
public String getReplyToSessionId()
Obtient ou définit un identificateur de session qui augmente l’adresse getReplyTo() .
Cette valeur incrémente l’information ReplyTo et spécifie la valeur SessionId qui doit être définie pour la réponse lors de son envoi à l’entité de réponse.
Returns:
getScheduledEnqueueTime
public OffsetDateTime getScheduledEnqueueTime()
Obtient l’heure d’attente planifiée de ce message.
Cette valeur est utilisée pour la disponibilité différée des messages. Le message est ajouté en toute sécurité à la file d’attente, mais il n’est pas considéré comme actif et ne peut donc pas être récupéré avant l’heure d’attente planifiée. N’oubliez pas que le message peut ne pas être activé (en file d’attente) à la date-heure exacte donnée ; le temps d’activation réel dépend de la charge de travail de la file d’attente et de son état.
Returns:
getSequenceNumber
public long getSequenceNumber()
Obtient le numéro unique attribué à un message par Service Bus.
Le numéro de séquence est un entier 64 bits unique attribué à un message lorsque celui-ci est accepté et stocké par le répartiteur, et fait office de véritable identificateur du message. Pour les entités partitionnées, les 16 premiers bits correspondent à l’identificateur de la partition. Les numéros de séquence augmentent de façon monotone et ininterrompue. Ils repassent à 0 lorsque la plage 48 à 64 bits est épuisée. Cette propriété est en lecture seule.
Returns:
getSessionId
public String getSessionId()
Obtient l’ID de session du message.
Dans le cas des entités prenant en charge la session, cette valeur définie par l’application spécifie l’affiliation de session du message. Les messages dotés du même identificateur de session sont soumis à un verrouillage du résumé et permettent un traitement et un démultiplexage chronologiques. Dans le cas des entités ne prenant pas en charge la session, cette valeur est ignorée. Consultez Sessions de messages.
Returns:
getState
public ServiceBusMessageState getState()
Obtient l’état du message. L’état du message peut être Actif, Différé ou Planifié. Les messages différés ont un état différé, les messages planifiés ont l’état Planifié, tous les autres messages ont l’état Actif.
Returns:
getSubject
public String getSubject()
Obtient l’objet du message.
Cette propriété permet à l’application d’indiquer de façon normalisée au destinataire la finalité du message, tout comme la ligne Objet d’un e-mail. La propriété AMQP mappée est « subject ».
Returns:
getTimeToLive
public Duration getTimeToLive()
Obtient la durée avant l’expiration de ce message.
Cette valeur est la durée relative après laquelle le message expire, à partir de la dateheure à laquelle le message a été accepté et stocké par le répartiteur, comme capturé dans getScheduledEnqueueTime(). Lorsqu’elle n’est pas définie explicitement, la valeur supposée est la valeur DefaultTimeToLive définie pour la file d’attente ou la rubrique correspondante. La valeur TimeToLive au niveau du message ne peut pas dépasser celle du paramètre DefaultTimeToLive de l’entité, et est automatiquement ajustée dans le cas contraire.
Returns:
getTo
public String getTo()
Obtient l’adresse « à ».
Cette propriété est réservée pour une utilisation ultérieure dans les scénarios de routage et est actuellement ignorée par le répartiteur proprement dit. Les applications peuvent utiliser cette valeur dans les scénarios de chaînage automatique pilotés par des règles pour indiquer la destination logique prévue du message.
Returns:
S’applique à
Azure SDK for Java