ServiceBusMessage Classe

Paquet:

com.azure.messaging.servicebus

Artefact Maven:

com.azure:azure-messaging-servicebus:7.17.0

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

public class ServiceBusMessage

Structure de données qui encapsule le message envoyé à Service Bus. La structure des messages est décrite en détail dans la documentation du produit.

Récapitulatif du constructeur

Constructeur	Description
ServiceBusMessage(byte[] body)	Crée un avec un ServiceBusMessage corps de tableau d’octets donné.
ServiceBusMessage(AmqpMessageBody amqpMessageBody)	Ce constructeur fournit un moyen simple de créer ServiceBusMessage avec le corps du message en tant que types SEQUENCE de données AMQP et VALUE.
ServiceBusMessage(BinaryData body)	Crée un ServiceBusMessage contenant le body. Fournit BinaryData diverses API pratiques représentant un tableau d’octets.
ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)	Crée un à l’aide ServiceBusMessage des propriétés à partir de receivedMessage.
ServiceBusMessage(String body)	Crée un ServiceBusMessage avec un UTF-8 corps encodé.

Résumé de la méthode

Modificateur et type	Méthode et description
ServiceBusMessage	addContext(String key, Object value) Ajoute une nouvelle paire clé-valeur au contexte existant sur Message.
Map<String,Object>	getApplicationProperties() Obtient l’ensemble des propriétés de forme ServiceBusMessage libre qui peuvent être utilisées pour passer les métadonnées associées au pendant les ServiceBusMessage opérations Service Bus.
BinaryData	getBody() Obtient la charge utile réelle encapsulée par .ServiceBusMessage
String	getContentType() Obtient le type de contenu du message.
String	getCorrelationId() Obtient un identificateur de corrélation.
String	getMessageId() Obtient l’ID du message.
String	getPartitionKey() Obtient la clé de partition pour l’envoi d’un message à une entité partitionnée.
AmqpAnnotatedMessage	getRawAmqpMessage() Obtient AmqpAnnotatedMessage.
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() .
OffsetDateTime	getScheduledEnqueueTime() Obtient l’heure d’attente planifiée de ce message.
String	getSessionId() Obtient l’identificateur de session d’une entité prenant en charge la session.
String	getSubject() Obtient l’objet du message.
Duration	getTimeToLive() Obtient la durée avant l’expiration de ce message.
String	getTo() Obtient l’adresse « à ».
ServiceBusMessage	setContentType(String contentType) Définit le type de contenu de .ServiceBusMessage
ServiceBusMessage	setCorrelationId(String correlationId) Définit un identificateur de corrélation.
ServiceBusMessage	setMessageId(String messageId) Définit l’ID de message.
ServiceBusMessage	setPartitionKey(String partitionKey) Définit une clé de partition pour l’envoi d’un message à une entité partitionnée
ServiceBusMessage	setReplyTo(String replyTo) Définit l’adresse d’une entité à laquelle envoyer des réponses.
ServiceBusMessage	setReplyToSessionId(String replyToSessionId) Obtient ou définit un identificateur de session qui augmente l’adresse getReplyTo() .
ServiceBusMessage	setScheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime) Définit l’heure d’attente planifiée de ce message.
ServiceBusMessage	setSessionId(String sessionId) Définit l’identificateur de session pour une entité prenant en charge la session.
ServiceBusMessage	setSubject(String subject) Définit l’objet du message.
ServiceBusMessage	setTimeToLive(Duration timeToLive) Définit la durée d’expiration de ce message.
ServiceBusMessage	setTo(String to) Définit l’adresse « à ».

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du constructeur

ServiceBusMessage

public ServiceBusMessage(byte[] body)

Crée un avec un ServiceBusMessage corps de tableau d’octets donné.

Parameters:

body - Contenu du message Service Bus.

ServiceBusMessage

public ServiceBusMessage(AmqpMessageBody amqpMessageBody)

Ce constructeur fournit un moyen simple de créer ServiceBusMessage avec le corps du message en tant que types SEQUENCE de données AMQP et VALUE. Dans le cas de SEQUENCE, tt prend en charge l’envoi et la réception d’une seule séquence AMQP à l’heure actuelle. Si vous envoyez un message avec un tableau d’octets unique ou des données string, vous pouvez également utiliser un autre constructeur.

Parameters:

amqpMessageBody - Corps du message amqp.

ServiceBusMessage

public ServiceBusMessage(BinaryData body)

Crée un ServiceBusMessage contenant le body. Fournit BinaryData diverses API pratiques représentant un tableau d’octets. Il fournit également un moyen de sérialiser Object dans BinaryData.

Parameters:

body - Données à définir pour ce ServiceBusMessage.

ServiceBusMessage

public ServiceBusMessage(ServiceBusReceivedMessage receivedMessage)

Crée un à l’aide ServiceBusMessage des propriétés à partir de receivedMessage. Il est normalement utilisé lorsqu’un ServiceBusReceivedMessage doit être envoyé à une autre entité.

Parameters:

receivedMessage - Message reçu à partir duquel créer un nouveau message.

ServiceBusMessage

public ServiceBusMessage(String body)

Crée un ServiceBusMessage avec un UTF-8 corps encodé.

Parameters:

body - Contenu du message Service Bus.

Détails de la méthode

addContext

public ServiceBusMessage addContext(String key, Object value)

Ajoute une nouvelle paire clé-valeur au contexte existant sur Message.

Parameters:

key - Clé de cet objet de contexte

value - Valeur de cet objet de contexte.

Returns:

ServiceBusMessage mise à jour.

getApplicationProperties

public Map getApplicationProperties()

Obtient l’ensemble des propriétés de forme ServiceBusMessage libre qui peuvent être utilisées pour passer les métadonnées associées au pendant les ServiceBusMessage opérations Service Bus. Un cas d’usage courant pour getApplicationProperties() est d’associer des indicateurs de sérialisation pour le getBody() comme une aide aux consommateurs qui souhaitent désérialiser les données binaires.

Returns:

Propriétés d’application associées à ce ServiceBusMessage.

getBody

public BinaryData getBody()

Obtient la charge utile réelle encapsulée par .ServiceBusMessage

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 le moyen de désérialiser les données brutes n’est pas apparent pour les consommateurs, une technique courante consiste à utiliser lors de la création de getApplicationProperties() l’événement, pour associer des indicateurs de sérialisation comme une aide aux consommateurs qui souhaitent désérialiser les données binaires.

Returns:

Données binaires représentant la charge utile.

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:

Type de contenu de ServiceBusMessage.

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:

ID de corrélation de ce message.

getMessageId

public String getMessageId()

Obtient l’ID 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:

ID de .ServiceBusMessage

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:

Clé de partition de ce message.

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

Obtient AmqpAnnotatedMessage.

Returns:

Message AMQP brut.

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:

Valeur de la propriété ReplyTo de ce message

getReplyToSessionId

public String getReplyToSessionId()

Obtient ou définit un identificateur de session qui augmente l’adresse getReplyTo() .

Cette valeur augmente les getReplyTo() informations et spécifie ce qui sessionId doit être défini pour la réponse lorsqu’elle est envoyée à l’entité de réponse.

Returns:

Valeur getReplyToGroupId de propriété de ce message.

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:

date-heure à laquelle le message sera mis en file d’attente dans Azure Service Bus

getSessionId

public String getSessionId()

Obtient l’identificateur de session d’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. Consultez Sessions de messages.

Returns:

ID de session de .ServiceBusMessage

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:

Objet du message.

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 l’instant où 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:

Durée de vie de ce message

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:

Valeur de la propriété « To » de ce message

setContentType

public ServiceBusMessage setContentType(String contentType)

Définit le type de contenu de .ServiceBusMessage

Décrit éventuellement la charge utile du message, avec un descripteur suivant le format de RFC2045, section 5, par exemple « application/json ».

Parameters:

contentType - RFC2045 descripteur Content-Type du message.

Returns:

ServiceBusMessage mise à jour.

setCorrelationId

public ServiceBusMessage setCorrelationId(String correlationId)

Définit un identificateur de corrélation.

Parameters:

correlationId - ID de corrélation de ce message

Returns:

ServiceBusMessage mise à jour.

setMessageId

public ServiceBusMessage setMessageId(String messageId)

Définit l’ID de message.

Parameters:

messageId - ID de message à définir.

Returns:

ServiceBusMessage mise à jour.

setPartitionKey

public ServiceBusMessage setPartitionKey(String partitionKey)

Définit une clé de partition pour l’envoi d’un message à une entité partitionnée

Parameters:

partitionKey - Clé de partition de ce message.

Returns:

ServiceBusMessage mise à jour.

setReplyTo

public ServiceBusMessage setReplyTo(String replyTo)

Définit l’adresse d’une entité à laquelle envoyer des réponses.

Parameters:

replyTo - Valeur de la propriété ReplyTo de ce message

Returns:

ServiceBusMessage mise à jour.

setReplyToSessionId

public ServiceBusMessage setReplyToSessionId(String replyToSessionId)

Obtient ou définit un identificateur de session qui augmente l’adresse getReplyTo() .

Parameters:

replyToSessionId - Valeur de la propriété ReplyToGroupId de ce message.

Returns:

ServiceBusMessage mise à jour.

setScheduledEnqueueTime

public ServiceBusMessage setScheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime)

Définit l’heure d’attente planifiée de ce message. Un null ne sera pas défini. Si cette valeur doit être supprimée, vous pouvez le faire en supprimant la valeur de l’utilisation de AmqpAnnotatedMessage#getMessageAnnotations() la clé AmqpMessageConstant#SCHEDULED_ENQUEUE_UTC_TIME_NAME.

Parameters:

scheduledEnqueueTime - dateheure à laquelle ce message doit être mis en file d’attente dans Azure Service Bus.

Returns:

ServiceBusMessage mise à jour.

setSessionId

public ServiceBusMessage setSessionId(String sessionId)

Définit l’identificateur de session pour une entité prenant en charge la session.

Parameters:

sessionId - Identificateur de session à définir.

Returns:

ServiceBusMessage mise à jour.

setSubject

public ServiceBusMessage setSubject(String subject)

Définit l’objet du message.

Parameters:

subject - Sujet spécifique à l’application.

Returns:

Objet mis à jour ServiceBusMessage .

setTimeToLive

public ServiceBusMessage setTimeToLive(Duration timeToLive)

Définit la durée d’expiration de ce message.

Parameters:

timeToLive - Durée de vie de ce message

Returns:

ServiceBusMessage mise à jour.

setTo

public ServiceBusMessage setTo(String to)

Définit 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.

Parameters:

to - Valeur de propriété de ce message.

Returns:

ServiceBusMessage mise à jour.