EventData Classe

Paquet:

com.azure.messaging.eventhubs

Artefact Maven:

com.azure:azure-messaging-eventhubs:5.18.4

• java.lang.Object
• • com.azure.core.models.MessageContent
  • • com.azure.messaging.eventhubs.EventData

public class EventData
extends MessageContent

Structure de données qui encapsule l’événement envoyé et reçu à partir d’Event Hubs. Chaque partition Event Hub peut être visualisées sous la forme d’un flux de EventData. Cette classe n’est pas thread-safe.

Récapitulatif du constructeur

Constructeur	Description
EventData()	Crée un événement avec un corps vide.
EventData(byte[] body)	Crée un événement contenant le body.
EventData(BinaryData body)	Crée un événement avec le fourni BinaryData comme charge utile.
EventData(String body)	Crée un événement en encodant le à l’aide du body jeu de caractères UTF-8.
EventData(ByteBuffer body)	Crée un événement contenant le body.

Résumé de la méthode

Modificateur et type	Méthode et description
EventData	addContext(String key, Object value) Ajoute une nouvelle paire clé-valeur au contexte existant sur les données d’événement.
boolean	equals(Object o) True si l’objet est un EventData et que le contenu binaire de getBody() est égal.
byte[]	getBody() Obtient la charge utile/les données encapsulées par les données d’événement.
BinaryData	getBodyAsBinaryData() Retourne la BinaryData charge utile associée à cet événement.
String	getBodyAsString() Retourne les données d’événement sous forme de chaîne décodée UTF-8.
String	getContentType() Obtient le type MIME décrivant les données contenues dans , getBody()destiné à permettre aux consommateurs de prendre des décisions éclairées pour l’inspection et le traitement de l’événement.
String	getCorrelationId() Obtient une valeur définie par l’application qui représente le contexte à utiliser pour la corrélation entre une ou plusieurs opérations.
Instant	getEnqueuedTime() Obtient l’instant, au format UTC, du moment où l’événement a été mis en file d’attente dans la partition Event Hub.
String	getMessageId() Obtient une valeur définie par l’application qui identifie l’événement de manière unique.
Long	getOffset() Obtient le décalage de l’événement lorsqu’il a été reçu de la partition Event Hub associée.
String	getPartitionKey() Obtient la clé de hachage de partition si elle a été définie lors de la publication initiale de l’événement.
Map<String,Object>	getProperties() Obtient l’ensemble des propriétés d’événement de forme libre qui peuvent être utilisées pour transmettre les métadonnées associées à l’événement avec le corps de l’événement pendant les opérations Event Hubs.
AmqpAnnotatedMessage	getRawAmqpMessage() Obtient le message AMQP sous-jacent.
Long	getSequenceNumber() Obtient le numéro de séquence attribué à l’événement lorsqu’il a été mis en file d’attente dans la partition Event Hub associée.
Map<String,Object>	getSystemProperties() Propriétés renseignées par le service Event Hubs.
int	hashCode() Obtient un hachage du contenu binaire dans getBody().
EventData	setBodyAsBinaryData(BinaryData binaryData) Définit un nouveau corps binaire et correspondant AmqpAnnotatedMessage à l’événement.
EventData	setContentType(String contentType) Définit le type MIME décrivant les données contenues dans , getBody()destiné à permettre aux consommateurs de prendre des décisions éclairées pour l’inspection et le traitement de l’événement.
EventData	setCorrelationId(String correlationId) Définit une valeur définie par l’application qui représente le contexte à utiliser pour la corrélation entre une ou plusieurs opérations.
EventData	setMessageId(String messageId) Définit une valeur définie par l’application qui identifie de manière unique l’événement.

Méthodes héritées de MessageContent

getBodyAsBinaryData getContentType setBodyAsBinaryData setContentType

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du constructeur

EventData

public EventData()

Crée un événement avec un corps vide.

EventData

public EventData(byte[] body)

Crée un événement contenant le body.

Parameters:

body - Données à définir pour cet événement.

EventData

public EventData(BinaryData body)

Crée un événement avec le fourni BinaryData comme charge utile.

Parameters:

body - Charge BinaryData utile pour cet événement.

EventData

public EventData(String body)

Crée un événement en encodant le à l’aide du body jeu de caractères UTF-8.

Parameters:

body - Chaîne qui sera encodée en UTF-8 pour créer un événement.

EventData

public EventData(ByteBuffer body)

Crée un événement contenant le body.

Parameters:

body - Données à définir pour cet événement.

Détails de la méthode

addContext

public EventData addContext(String key, Object value)

Ajoute une nouvelle paire clé-valeur au contexte existant sur les données d’événement.

Parameters:

key - Clé de cet objet de contexte

value - Valeur de cet objet de contexte.

Returns:

EventData mise à jour.

equals

public boolean equals(Object o)

True si l’objet est un EventData et que le contenu binaire de getBody() est égal.

Overrides:

EventData.equals(Object o)

Parameters:

o

getBody

public byte[] getBody()

Obtient la charge utile/les données encapsulées par EventData.

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 getProperties() 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:

Tableau d’octets représentant les données.

getBodyAsBinaryData

public BinaryData getBodyAsBinaryData()

Retourne la BinaryData charge utile associée à cet événement.

Overrides:

EventData.getBodyAsBinaryData()

Returns:

charge BinaryData utile associée à cet événement.

getBodyAsString

public String getBodyAsString()

Retourne les données d’événement sous forme de chaîne décodée UTF-8.

Returns:

Représentation sous forme de chaîne décodée UTF-8 des données d’événement.

getContentType

public String getContentType()

Obtient le type MIME décrivant les données contenues dans , getBody()destiné à permettre aux consommateurs de prendre des décisions éclairées pour l’inspection et le traitement de l’événement.

Overrides:

EventData.getContentType()

Returns:

Type de contenu.

getCorrelationId

public String getCorrelationId()

Obtient une valeur définie par l’application qui représente le contexte à utiliser pour la corrélation entre une ou plusieurs opérations. L’identificateur est une valeur de forme libre qui peut refléter une identité unique ou un élément de données partagé avec une importance pour l’application.

Returns:

ID de corrélation. null s’il n’y en a aucun défini.

getEnqueuedTime

public Instant getEnqueuedTime()

Obtient l’instant, au format UTC, du moment où l’événement a été mis en file d’attente dans la partition Event Hub. Ce n’est présent que sur un reçuEventData.

Returns:

L’instant, en UTC, a été mis en file d’attente dans la partition Event Hub. null si le n’a EventData pas été reçu du service Event Hubs.

getMessageId

public String getMessageId()

Obtient une valeur définie par l’application qui identifie l’événement de manière unique. L’identificateur est une valeur de forme libre qui peut refléter un GUID ou un identificateur dérivé du contexte de l’application.

Returns:

ID du message. null s’il n’y en a aucun défini.

getOffset

public Long getOffset()

Obtient le décalage de l’événement lorsqu’il a été reçu de la partition Event Hub associée. Ce n’est présent que sur un reçuEventData.

Returns:

Décalage dans la partition Event Hub de l’événement reçu. null si le n’a EventData pas été reçu du service Event Hubs.

getPartitionKey

public String getPartitionKey()

Obtient la clé de hachage de partition si elle a été définie lors de la publication initiale de l’événement. Si elle existe, cette valeur a été utilisée pour calculer un hachage pour sélectionner une partition à laquelle envoyer le message. Ce n’est présent que sur un reçuEventData.

Returns:

Clé de partition pour ces données d’événement. null si le n’a EventData pas été reçu du service Event Hubs ou s’il n’y avait pas de clé de partition définie lors de l’envoi de l’événement au hub d’événements.

getProperties

public Map getProperties()

Obtient l’ensemble des propriétés d’événement de forme libre qui peuvent être utilisées pour transmettre les métadonnées associées à l’événement avec le corps de l’événement pendant les opérations Event Hubs. Un cas d’usage courant pour properties() 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.

Ajout d’un indicateur de sérialisation à l’aide de getProperties()

Dans l’exemple, le type de télémétrie est indiqué en ajoutant une propriété d’application avec la clé « eventType ».

TelemetryEvent telemetry = new TelemetryEvent("temperature", "37");
 byte[] serializedTelemetryData = telemetry.toString().getBytes(UTF_8);

 EventData eventData = new EventData(serializedTelemetryData);
 eventData.getProperties().put("eventType", TelemetryEvent.class.getName());

Les types suivants sont pris en charge :

• Character
• Date
• Double
• Float
• Integer
• Long
• Short
• String

Returns:

Propriétés d’application associées à ce EventData. Pour reçu EventData, la carte est une vue en lecture seule.

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

Obtient le message AMQP sous-jacent.

Returns:

Message AMQP sous-jacent.

getSequenceNumber

public Long getSequenceNumber()

Obtient le numéro de séquence attribué à l’événement lorsqu’il a été mis en file d’attente dans la partition Event Hub associée. Ceci est unique pour chaque message reçu dans la partition Event Hub. Ce n’est présent que sur un reçuEventData.

Returns:

Numéro de séquence de cet événement. null si le n’a EventData pas été reçu du service Event Hubs.

getSystemProperties

public Map getSystemProperties()

Propriétés renseignées par le service Event Hubs. Étant donné qu’ils sont remplis par le service Event Hubs, ils ne sont présents que sur un reçuEventData. Fournit une abstraction par-dessus les propriétés exposées par getRawAmqpMessage(). Ces propriétés sont en lecture seule et peuvent être modifiées via getRawAmqpMessage().

Returns:

Encapsulation de toutes les propriétés système ajoutées par le service EventHubs à EventData. Si le EventData n’est pas reçu du service Event Hubs, les valeurs retournées sont null.

hashCode

public int hashCode()

Obtient un hachage du contenu binaire dans getBody().

Overrides:

EventData.hashCode()

setBodyAsBinaryData

public EventData setBodyAsBinaryData(BinaryData binaryData)

Définit un nouveau corps binaire et correspondant AmqpAnnotatedMessage à l’événement. Le contenu de getRawAmqpMessage() est copié de peu dans le nouveau message sous-jacent.

Overrides:

EventData.setBodyAsBinaryData(BinaryData binaryData)

Parameters:

binaryData

setContentType

public EventData setContentType(String contentType)

Définit le type MIME décrivant les données contenues dans , getBody()destiné à permettre aux consommateurs de prendre des décisions éclairées pour l’inspection et le traitement de l’événement.

Overrides:

EventData.setContentType(String contentType)

Parameters:

contentType - Type de contenu.

Returns:

EventData mise à jour.

setCorrelationId

public EventData setCorrelationId(String correlationId)

Définit une valeur définie par l’application qui représente le contexte à utiliser pour la corrélation entre une ou plusieurs opérations. L’identificateur est une valeur de forme libre qui peut refléter une identité unique ou un élément de données partagé avec une importance pour l’application.

Parameters:

correlationId - ID de corrélation.

Returns:

EventData mise à jour.

setMessageId

public EventData setMessageId(String messageId)

Définit une valeur définie par l’application qui identifie de manière unique l’événement. L’identificateur est une valeur de forme libre qui peut refléter un GUID ou un identificateur dérivé du contexte de l’application.

Parameters:

messageId - ID du message.

Returns:

EventData mise à jour.