IMessage Interface
public interface IMessage
Représente le message échangé entre Azure Service Bus et ses clients.
Résumé de la méthode
| Modificateur et type | Méthode et description |
|---|---|
| abstract IMessage |
createCopy()
Crée une copie superficielle de ce message. |
| abstract byte[] |
getBody()
Déprécié
Le corps du message n’a pas besoin uniquement d’un tableau d’octets. Remplacé par getMessageBody()
Obtient le corps de ce message sous forme de tableau d’octets. |
| abstract String |
getContentType()
Obtient le type de contenu de ce message. |
| abstract String |
getCorrelationId()
Obtient un identificateur de corrélation. |
| abstract 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 désactivé. |
| abstract long |
getDeliveryCount()
Obtient le nombre de fois où ce message a été remis aux clients. |
| abstract Instant |
getEnqueuedTimeUtc()
Obtient l’instant auquel ce message a été mis en file d’attente dans Azure Service Bus. |
| abstract Instant |
getExpiresAtUtc()
Obtient l’instant auquel ce message expire. |
| abstract String |
getLabel()
Obtient l’étiquette de message spécifique à l’application. |
| abstract UUID |
getLockToken()
Obtient le jeton de verrouillage du message actuel. |
| abstract Instant |
getLockedUntilUtc()
Obtient l’instant auquel le verrou de ce message expire. |
|
abstract
Message |
getMessageBody()
Obtient le corps de ce message. |
| abstract String |
getMessageId()
Obtient l’ID de ce message. |
| abstract String |
getPartitionKey()
Obtient la clé de partition pour l’envoi d’un message à une entité partitionnée. |
| abstract Map<String,Object> |
getProperties()
Obtient la carte des propriétés de l’application utilisateur de ce message. |
| abstract String |
getReplyTo()
Obtient l’adresse d’une entité à laquelle envoyer des réponses. |
| abstract String |
getReplyToSessionId()
Obtient ou définit un identificateur de session qui augmente l’adresse getReplyTo() . |
| abstract Instant |
getScheduledEnqueueTimeUtc()
Obtient l’heure d’attente planifiée de ce message. |
| abstract Instant |
getScheduledEnqueuedTimeUtc()
Déprécié
Remplacé par getScheduledEnqueueTimeUtc()
Obtient l’heure d’attente planifiée de ce message. |
| abstract long |
getSequenceNumber()
Obtient le numéro unique attribué à un message par Service Bus. |
| abstract String |
getSessionId()
Obtient l’identificateur de session pour une entité prenant en charge la session. |
| abstract Duration |
getTimeToLive()
Obtient la durée avant l’expiration de ce message. |
| abstract String |
getTo()
Obtient l’adresse « à ». |
| abstract String |
getViaPartitionKey()
Obtient la clé de partition pour l’envoi d’un message à une entité via une autre entité de transfert partitionnée. |
| abstract void |
setBody(byte[] body)
Déprécié
Le corps du message n’a pas besoin d’un tableau d’octets. Remplacé par setMessageBody(MessageBody body)
Définit le corps de ce message sous la forme d’un tableau d’octets. |
| abstract void |
setContentType(String contentType)
Définit le type de contenu de ce message. |
| abstract void |
setCorrelationId(String correlationId)
Définit un identificateur de corrélation. |
| abstract void |
setLabel(String label)
Définit une étiquette de message spécifique à l’application. |
| abstract void |
setMessageBody(MessageBody body)
Définit le corps de ce message. |
| abstract void |
setMessageId(String messageId)
Définit l’ID de ce message. |
| abstract void |
setPartitionKey(String partitionKey)
Définit une clé de partition pour l’envoi d’un message à une entité partitionnée |
| abstract void |
setProperties(Map<String,Object> properties)
Définit la carte des propriétés de l’application utilisateur de ce message. |
| abstract void |
setReplyTo(String replyTo)
Définit l’adresse d’une entité à laquelle envoyer des réponses. |
| abstract void |
setReplyToSessionId(String replyToSessionId)
Obtient ou définit un identificateur de session qui augmente l’adresse getReplyTo() . |
| abstract void |
setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc)
Définit l’heure de mise en file d’attente planifiée de ce message. |
| abstract void |
setScheduledEnqueuedTimeUtc(Instant scheduledEnqueueTimeUtc)
Déprécié Définit l’heure de mise en file d’attente planifiée de ce message. |
| abstract void |
setSessionId(String sessionId)
Définit l’identificateur de session pour une entité prenant en charge la session. |
| abstract void |
setTimeToLive(Duration timeToLive)
Définit la durée avant l’expiration de ce message. |
| abstract void |
setTo(String to)
Définit l’adresse « to ». |
| abstract void |
setViaPartitionKey(String viaPartitionKey)
Définit une clé via-partition pour l’envoi d’un message à une entité de destination via une autre entité partitionnée |
Détails de la méthode
createCopy
public abstract IMessage createCopy()
Crée une copie superficielle de ce message.
Retours:
getBody
@Deprecated
public abstract byte[] getBody()
Déprécié
Obtient le corps de ce message sous forme de tableau d’octets. Il appartient aux applications clientes de décoder les octets.
Retours:
getContentType
public abstract String getContentType()
Obtient le type de contenu de ce message. Décrit éventuellement la charge utile du message, avec un descripteur suivant le format de RFC2045, section 5, par exemple « application/json ». Notez que le type de contenu n’est pas identique au type de corps de message.
Retours:
getCorrelationId
public abstract 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.
Retours:
getDeadLetterSource
public abstract 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 désactivé. 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é. Elle indique l’entité dans laquelle le message a été placé comme message de lettres mortes. Cette propriété est en lecture seule.
Retours:
getDeliveryCount
public abstract 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. Cette propriété est en lecture seule.
Retours:
getEnqueuedTimeUtc
public abstract Instant getEnqueuedTimeUtc()
Obtient l’instant auquel ce message a été mis en file d’attente dans Azure Service Bus. Cette propriété indique l’heure UTC à 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. Cette propriété est en lecture seule.
Retours:
getExpiresAtUtc
public abstract Instant getExpiresAtUtc()
Obtient l’instant auquel ce message expire. La valeur est l’instant UTC pour quand le message est planifié pour la suppression et ne sera plus disponible pour la récupération à partir de l’entité en raison de l’expiration. L’expiration est contrôlée par la getTimeToLive() propriété . Cette propriété est calculée à partir de getEnqueuedTimeUtc()+getTimeToLive().
Retours:
getLabel
public abstract String getLabel()
Obtient l’étiquette de message spécifique à l’application. 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 ».
Retours:
getLockToken
public abstract UUID getLockToken()
Obtient le jeton de verrouillage du message actuel. Le jeton de verrou est une référence au verrou détenu par le répartiteur en mode PEEKLOCK. Les verrous sont utilisés pour régler explicitement les messages, comme expliqué plus en détail dans la documentation du produit. Le jeton peut également être utilisé pour épingler définitivement le verrou via l’API Deferral et, avec cela, sortir le message du flux d’état de remise normal. Cette propriété est en lecture seule.
Retours:
getLockedUntilUtc
public abstract Instant getLockedUntilUtc()
Obtient l’instant auquel le verrou de ce message expire. Dans le cas des messages récupérés avec un verrouillage (mode de réception peek-lock, non préalablement réglé), cette propriété reflète l’heure UTC jusqu’à laquelle le message reste 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.
Retours:
getMessageBody
public abstract MessageBody getMessageBody()
Obtient le corps de ce message. Les applications clientes doivent extraire le contenu du message en fonction du type de corps.
Retours:
getMessageId
public abstract String getMessageId()
Obtient l’ID de ce 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 elle 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.
Retours:
getPartitionKey
public abstract 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.
Retours:
getProperties
public abstract Map
Obtient la carte des propriétés de l’application utilisateur de ce message. Les applications clientes peuvent définir des propriétés utilisateur (en-têtes) sur le message à l’aide de cette carte.
Retours:
getReplyTo
public abstract 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.
Retours:
getReplyToSessionId
public abstract 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.
Retours:
getScheduledEnqueueTimeUtc
public abstract Instant getScheduledEnqueueTimeUtc()
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) à l’instant exact donné ; le temps d’activation réel dépend de la charge de travail de la file d’attente et de son état.
Retours:
getScheduledEnqueuedTimeUtc
@Deprecated
public abstract Instant getScheduledEnqueuedTimeUtc()
Déprécié
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) à l’instant exact donné ; le temps d’activation réel dépend de la charge de travail de la file d’attente et de son état.
Retours:
getSequenceNumber
public abstract 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.
Retours:
getSessionId
public abstract String getSessionId()
Obtient l’identificateur de session pour une entité prenant en charge la session. 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.
Retours:
getTimeToLive
public abstract 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 l’instant où le message a été accepté et stocké par le répartiteur, comme capturé dans getEnqueuedTimeUtc(). 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.
Retours:
getTo
public abstract String getTo()
Obtient l’adresse « à ».
Retours:
getViaPartitionKey
public abstract String getViaPartitionKey()
Obtient la clé de partition pour l’envoi d’un message à une entité via une autre entité de transfert partitionnée. Si un message est envoyé via une file d’attente de transfert dans l’étendue d’une transaction, cette valeur sélectionne la partition de file d’attente de transfert : cette valeur est fonctionnellement équivalente à getPartitionKey() et garantit que les messages sont conservés ensemble et dans l’ordre à mesure qu’ils sont transférés.
Retours:
setBody
@Deprecated
public abstract void setBody(byte[] body)
Déprécié
Définit le corps de ce message sous la forme d’un tableau d’octets.
Paramètres:
setContentType
public abstract void setContentType(String contentType)
Définit le type de contenu de ce message.
Paramètres:
setCorrelationId
public abstract void setCorrelationId(String correlationId)
Définit un identificateur de corrélation.
Paramètres:
setLabel
public abstract void setLabel(String label)
Définit une étiquette de message spécifique à l’application.
Paramètres:
setMessageBody
public abstract void setMessageBody(MessageBody body)
Définit le corps de ce message.
Paramètres:
setMessageId
public abstract void setMessageId(String messageId)
Définit l’ID de ce message.
Paramètres:
setPartitionKey
public abstract void setPartitionKey(String partitionKey)
Définit une clé de partition pour l’envoi d’un message à une entité partitionnée
Paramètres:
setProperties
public abstract void setProperties(Map
Définit la carte des propriétés de l’application utilisateur de ce message. Les applications clientes peuvent définir les propriétés utilisateur sur le message à l’aide de cette carte.
Paramètres:
setReplyTo
public abstract void setReplyTo(String replyTo)
Définit l’adresse d’une entité à laquelle envoyer des réponses.
Paramètres:
setReplyToSessionId
public abstract void setReplyToSessionId(String replyToSessionId)
Obtient ou définit un identificateur de session qui augmente l’adresse getReplyTo() .
Paramètres:
setScheduledEnqueueTimeUtc
public abstract void setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc)
Définit l’heure de mise en file d’attente planifiée de ce message.
Paramètres:
setScheduledEnqueuedTimeUtc
@Deprecated
public abstract void setScheduledEnqueuedTimeUtc(Instant scheduledEnqueueTimeUtc)
Déprécié
Définit l’heure de mise en file d’attente planifiée de ce message.
Paramètres:
setSessionId
public abstract void setSessionId(String sessionId)
Définit l’identificateur de session pour une entité prenant en charge la session.
Paramètres:
setTimeToLive
public abstract void setTimeToLive(Duration timeToLive)
Définit la durée avant l’expiration de ce message.
Paramètres:
setTo
public abstract void setTo(String to)
Définit l’adresse « to ». 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é par des règles pour indiquer la destination logique prévue du message.
Paramètres:
setViaPartitionKey
public abstract void setViaPartitionKey(String viaPartitionKey)
Définit une clé via-partition pour l’envoi d’un message à une entité de destination via une autre entité partitionnée
Paramètres:
S’applique à
Azure SDK for Java