ReceivedEventData interface

Pakket:

@azure/event-hubs

De interface die de structuur beschrijft van de gebeurtenis die is ontvangen van Event Hub. Gebruik deze functie als referentie bij het maken van de functie processEvents om de gebeurtenissen te verwerken die zijn ontvangen van een Event Hub wanneer u de EventHubConsumerClientgebruikt.

Eigenschappen

body	De hoofdtekst van het bericht dat moet worden verzonden of ontvangen.
contentType	Het inhoudstype van het bericht. Beschrijft eventueel de nettolading van het bericht, met een descriptor volgens de indeling van RFC2045, sectie 5, bijvoorbeeld 'application/json'.
correlationId	De correlatie-id waarmee een toepassing een context voor het bericht kan opgeven voor het doel van correlatie, bijvoorbeeld door de MessageId weer te geven van een bericht waarop wordt gereageerd.
enqueuedTimeUtc	De tijd van het evenement.
messageId	De bericht-id is een door de toepassing gedefinieerde waarde waarmee het bericht en de nettolading uniek worden geïdentificeerd.
offset	De offset van de gebeurtenis.
partitionKey	Wanneer de opgegeven Event Hub deze hasht naar een partitionId. Het garandeert dat berichten in een specifieke partitie op de Event Hub terechtkomen.
properties	De toepassingsspecifieke eigenschappen.
sequenceNumber	Het volgnummer van de gebeurtenis.
systemProperties	De eigenschappen die door de service zijn ingesteld.

Methoden

getRawAmqpMessage()

Retourneert het onderliggende onbewerkte amqp-bericht.

Eigenschapdetails

body

De hoofdtekst van het bericht dat moet worden verzonden of ontvangen.

body: any

Waarde van eigenschap

any

contentType

Het inhoudstype van het bericht. Beschrijft eventueel de nettolading van het bericht, met een descriptor volgens de indeling van RFC2045, sectie 5, bijvoorbeeld 'application/json'.

contentType?: string

Waarde van eigenschap

string

correlationId

De correlatie-id waarmee een toepassing een context voor het bericht kan opgeven voor het doel van correlatie, bijvoorbeeld door de MessageId weer te geven van een bericht waarop wordt gereageerd.

correlationId?: string | number | Buffer

Waarde van eigenschap

string | number | Buffer

enqueuedTimeUtc

De tijd van het evenement.

enqueuedTimeUtc: Date

Waarde van eigenschap

Date

messageId

De bericht-id is een door de toepassing gedefinieerde waarde waarmee het bericht en de nettolading uniek worden geïdentificeerd.

messageId?: string | number | Buffer

Waarde van eigenschap

string | number | Buffer

offset

De offset van de gebeurtenis.

offset: number

Waarde van eigenschap

number

partitionKey

Wanneer de opgegeven Event Hub deze hasht naar een partitionId. Het garandeert dat berichten in een specifieke partitie op de Event Hub terechtkomen.

partitionKey: null | string

Waarde van eigenschap

null | string

properties

De toepassingsspecifieke eigenschappen.

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

Waarde van eigenschap

{[key: string]: any}

sequenceNumber

Het volgnummer van de gebeurtenis.

sequenceNumber: number

Waarde van eigenschap

number

systemProperties

De eigenschappen die door de service zijn ingesteld.

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

Waarde van eigenschap

{[key: string]: any}

Methodedetails

getRawAmqpMessage()

Retourneert het onderliggende onbewerkte amqp-bericht.

function getRawAmqpMessage(): AmqpAnnotatedMessage

Retouren

AmqpAnnotatedMessage