ReceivedEventData interface

Paquet:

@azure/event-hubs

Interface qui décrit la structure de l’événement reçu d’Event Hub. Utilisez-le comme référence lors de la création de la processEvents fonction pour traiter les événements reçus d’un Event Hub lors de l’utilisation de EventHubConsumerClient.

Propriétés

body	Corps du message qui doit être envoyé ou reçu.
contentType	Type de contenu du message. Décrit éventuellement la charge utile du message, avec un descripteur au format RFC2045, Section 5, par exemple « application/json ».
correlationId	Identificateur de corrélation qui permet à une application de spécifier un contexte pour le message à des fins de corrélation, par exemple en reflétant le MessageId d’un message auquel une réponse est envoyée.
enqueuedTimeUtc	Heure de l’événement en file d’attente.
messageId	L’identificateur de message est une valeur définie par l’application qui identifie de manière unique le message et sa charge utile.
offset	Décalage de l’événement.
partitionKey	Lorsque le hub d’événements spécifié est haché sur un partitionId. Il garantit que les messages se retrouvent dans une partition spécifique sur le hub d’événements.
properties	Propriétés spécifiques à l’application.
sequenceNumber	Numéro de séquence de l’événement.
systemProperties	Propriétés définies par le service.

Méthodes

getRawAmqpMessage()

Retourne le message amqp brut sous-jacent.

Détails de la propriété

body

Corps du message qui doit être envoyé ou reçu.

body: any

Valeur de propriété

any

contentType

Type de contenu du message. Décrit éventuellement la charge utile du message, avec un descripteur au format RFC2045, Section 5, par exemple « application/json ».

contentType?: string

Valeur de propriété

string

correlationId

Identificateur de corrélation qui permet à une application de spécifier un contexte pour le message à des fins de corrélation, par exemple en reflétant le MessageId d’un message auquel une réponse est envoyée.

correlationId?: string | number | Buffer

Valeur de propriété

string | number | Buffer

enqueuedTimeUtc

Heure de l’événement en file d’attente.

enqueuedTimeUtc: Date

Valeur de propriété

Date

messageId

L’identificateur de message est une valeur définie par l’application qui identifie de manière unique le message et sa charge utile.

messageId?: string | number | Buffer

Valeur de propriété

string | number | Buffer

offset

Décalage de l’événement.

offset: number

Valeur de propriété

number

partitionKey

Lorsque le hub d’événements spécifié est haché sur un partitionId. Il garantit que les messages se retrouvent dans une partition spécifique sur le hub d’événements.

partitionKey: null | string

Valeur de propriété

null | string

properties

Propriétés spécifiques à l’application.

properties?: {[key: string]: any}

Valeur de propriété

{[key: string]: any}

sequenceNumber

Numéro de séquence de l’événement.

sequenceNumber: number

Valeur de propriété

number

systemProperties

Propriétés définies par le service.

systemProperties?: {[key: string]: any}

Valeur de propriété

{[key: string]: any}

Détails de la méthode

getRawAmqpMessage()

Retourne le message amqp brut sous-jacent.

function getRawAmqpMessage(): AmqpAnnotatedMessage

Retours

AmqpAnnotatedMessage