ServiceBusReceivedMessage interface

Pakket:

@azure/service-bus

Beschrijft het bericht dat is ontvangen van Service Bus tijdens het bekijken van bewerkingen en kan dus niet worden vereffend.

Uitbreiding

ServiceBusMessage

Eigenschappen

deadLetterErrorDescription	De beschrijving van de fout voor het schrijven van het bericht.
deadLetterReason	De reden voor het overletteren van het bericht.
deadLetterSource	De naam van de wachtrij of het abonnement waarop dit bericht is verzonden, voordat het is overgeslagen. Alleen ingesteld in berichten die zijn geschreven en die vervolgens automatisch zijn doorgestuurd vanuit de subwachtrij met dode letters naar een andere entiteit. Hiermee wordt de entiteit aangegeven waarin het bericht niet is geschreven.
deliveryCount	Aantal leveringen dat is geprobeerd voor dit bericht. Het aantal wordt verhoogd wanneer een berichtvergrendeling verloopt of het bericht expliciet wordt afgelaten met behulp van de methode abandon() op het bericht.
enqueuedSequenceNumber	Het oorspronkelijke volgnummer van het bericht. Voor berichten die automatisch zijn doorgestuurd, weerspiegelt deze eigenschap het volgnummer dat voor het eerst aan het bericht was toegewezen op het oorspronkelijke tijdstip van indiening.
enqueuedTimeUtc	Het UTC-moment waarop het bericht is geaccepteerd en opgeslagen in Service Bus.
expiresAtUtc	Het UTC-moment waarop het bericht is gemarkeerd voor verwijdering en die niet meer beschikbaar is voor het ophalen van de entiteit vanwege een vervaldatum. Deze eigenschap wordt berekend op basis van 2 andere eigenschappen in het bericht: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Het UTC-chatbericht totdat het bericht is vergrendeld in de wachtrij/het abonnement. Wanneer de vergrendeling verloopt, wordt de deliveryCount verhoogd en is het bericht opnieuw beschikbaar voor het ophalen. Niet van toepassing wanneer het bericht wordt ontvangen in receiveAndDelete ontvangstmodus. wijze.
lockToken	Het vergrendelingstoken is een verwijzing naar de vergrendeling die wordt vastgehouden door de broker in peekLock ontvangstmodus. Vergrendelingen worden intern gebruikt om berichten te vereffenen, zoals wordt uitgelegd in de productdocumentatie in meer detail Niet van toepassing wanneer het bericht wordt ontvangen in receiveAndDelete ontvangstmodus. wijze.
sequenceNumber	Het unieke nummer dat is toegewezen aan een bericht door Service Bus. Het volgnummer is een uniek 64-bits geheel getal dat is toegewezen aan een bericht omdat het wordt geaccepteerd en opgeslagen door de broker en fungeert als de ware id. Voor gepartitioneerde entiteiten weerspiegelen de bovenste 16 bits de partitie-id. De reeksnummers nemen monotonisch toe. Ze rollen over naar 0 wanneer het 48-64-bits bereik is uitgeput. Max, veilig geheel getal dat momenteel door Javascript wordt ondersteund, is 2^53 - 1. Het volgnummer is een AMQP-Long type dat maximaal 64 bits lang kan zijn. Om aan te geven dat we een bibliotheek met de naam long.jsgebruiken. We verwachten dat klanten het Long type gebruiken dat door deze bibliotheek wordt geëxporteerd.
state	De status van het bericht kan actief, uitgesteld of gepland zijn. Uitgestelde berichten hebben de status uitgesteld, geplande berichten hebben de geplande status, alle andere berichten hebben de actieve status.

Overgenomen eigenschappen

applicationProperties	De toepassingsspecifieke eigenschappen die kunnen worden gebruikt voor aangepaste berichtmetagegevens.
body	De hoofdtekst van het bericht dat moet worden verzonden of ontvangen. Als de toepassing die het bericht ontvangt, deze SDK niet gebruikt, converteert u de nettolading van uw hoofdtekst naar een bytematrix of buffer voor betere compatibiliteit tussen talen.
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. Zie berichtroutering en correlatie-.
messageId	De bericht-id is een door de toepassing gedefinieerde waarde waarmee het bericht en de nettolading uniek worden geïdentificeerd. Opmerking: getallen die geen gehele gehele getallen zijn, zijn niet toegestaan.
partitionKey	De partitiesleutel voor het verzenden van een bericht naar een gepartitioneerde entiteit. De maximale lengte is 128 tekens. Voor gepartitioneerde entiteitenkunt u met deze waarde gerelateerde berichten toewijzen aan dezelfde interne partitie, zodat de volgordevolgorde van de inzending correct wordt vastgelegd. De partitie wordt gekozen door een hash-functie boven deze waarde en kan niet rechtstreeks worden gekozen. Voor sessiebewuste entiteiten overschrijft de eigenschap sessionId deze waarde. Voor niet-gepartitioneerde entiteiten wordt de partitiesleutel genegeerd
replyTo	Het adres van een entiteit waarnaar antwoorden moeten worden verzonden. Deze optionele en toepassingsgedefinieerde waarde is een standaardmethode om een antwoordpad uit te drukken naar de ontvanger van het bericht. Wanneer een afzender een antwoord verwacht, wordt de waarde ingesteld op het absolute of relatieve pad van de wachtrij of het onderwerp waarnaar het antwoord wordt verzonden. Zie berichtroutering en correlatie-.
replyToSessionId	Met de sessie-id wordt het replyTo adres vergroot. De maximale lengte is 128 tekens. Deze waarde vergroot de replyTo-informatie en geeft aan welke SessionId moet worden ingesteld voor het antwoord wanneer deze naar de antwoordentiteit wordt verzonden. Zie berichtroutering en correlatie-.
scheduledEnqueueTimeUtc	De datum en tijd in UTC waarop het bericht wordt ge enqueued. Deze eigenschap retourneert de tijd in UTC; Bij het instellen van de eigenschap moet de opgegeven Datum/tijd-waarde ook in UTC staan. Deze waarde is bedoeld voor het verzenden van vertraagde berichten. Het wordt gebruikt om berichten die in de toekomst naar een bepaald tijdstip worden verzonden, uit te stellen. De tijd voor het enqueueren van berichten betekent niet dat het bericht tegelijkertijd wordt verzonden. Het wordt geïntenseueerd, maar de werkelijke verzendtijd is afhankelijk van de workload van de wachtrij en de status ervan.
sessionId	De sessie-id voor een sessiebewuste entiteit. De maximale lengte is 128 tekens. Voor sessiebewuste entiteiten geeft deze toepassingsgedefinieerde waarde de sessierelatie van het bericht op. Berichten met dezelfde sessie-id zijn onderworpen aan samenvattingsvergrendeling en kunnen exact in-orderverwerking en demultiplexing inschakelen. Voor entiteiten die zich niet bewust zijn van de sessie, wordt deze waarde genegeerd. berichtsessies.
subject	Het toepassingsspecifieke label. Met deze eigenschap kan de toepassing het doel van het bericht aangeven aan de ontvanger in een gestandaardiseerde. mode, vergelijkbaar met een onderwerpregel voor e-mail. De toegewezen AMQP-eigenschap is 'subject'.
timeToLive	De time to live-waarde van het bericht. Deze waarde is de relatieve duur waarna het bericht verloopt, vanaf het chatbericht is geaccepteerd en opgeslagen door de broker, zoals vastgelegd in enqueuedTimeUtc. Als deze waarde niet expliciet is ingesteld, is de veronderstelde waarde de DefaultTimeToLive voor de respectieve wachtrij of het betreffende onderwerp. Een timeToLive waarde op berichtniveau kan niet langer zijn dan de instelling DefaultTimeToLive van de entiteit en wordt op de achtergrond aangepast als dit wel het geval is. Zie vervaldatum.
to	Het adres 'aan'. Deze eigenschap is gereserveerd voor toekomstig gebruik in routeringsscenario's en wordt momenteel genegeerd door de broker zelf. Toepassingen kunnen deze waarde gebruiken in regelgestuurde automatisch koppelen scenario's om de beoogde logische bestemming van het bericht aan te geven.

Eigenschapdetails

deadLetterErrorDescription

De beschrijving van de fout voor het schrijven van het bericht.

deadLetterErrorDescription?: string

Waarde van eigenschap

string

deadLetterReason

De reden voor het overletteren van het bericht.

deadLetterReason?: string

Waarde van eigenschap

string

deadLetterSource

De naam van de wachtrij of het abonnement waarop dit bericht is verzonden, voordat het is overgeslagen. Alleen ingesteld in berichten die zijn geschreven en die vervolgens automatisch zijn doorgestuurd vanuit de subwachtrij met dode letters naar een andere entiteit. Hiermee wordt de entiteit aangegeven waarin het bericht niet is geschreven.

deadLetterSource?: string

Waarde van eigenschap

string

deliveryCount

Aantal leveringen dat is geprobeerd voor dit bericht. Het aantal wordt verhoogd wanneer een berichtvergrendeling verloopt of het bericht expliciet wordt afgelaten met behulp van de methode abandon() op het bericht.

deliveryCount?: number

Waarde van eigenschap

number

enqueuedSequenceNumber

Het oorspronkelijke volgnummer van het bericht. Voor berichten die automatisch zijn doorgestuurd, weerspiegelt deze eigenschap het volgnummer dat voor het eerst aan het bericht was toegewezen op het oorspronkelijke tijdstip van indiening.

enqueuedSequenceNumber?: number

Waarde van eigenschap

number

enqueuedTimeUtc

Het UTC-moment waarop het bericht is geaccepteerd en opgeslagen in Service Bus.

enqueuedTimeUtc?: Date

Waarde van eigenschap

Date

expiresAtUtc

Het UTC-moment waarop het bericht is gemarkeerd voor verwijdering en die niet meer beschikbaar is voor het ophalen van de entiteit vanwege een vervaldatum. Deze eigenschap wordt berekend op basis van 2 andere eigenschappen in het bericht: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Waarde van eigenschap

Date

lockedUntilUtc

Het UTC-chatbericht totdat het bericht is vergrendeld in de wachtrij/het abonnement. Wanneer de vergrendeling verloopt, wordt de deliveryCount verhoogd en is het bericht opnieuw beschikbaar voor het ophalen.

• Niet van toepassing wanneer het bericht wordt ontvangen in receiveAndDelete ontvangstmodus. wijze.

lockedUntilUtc?: Date

Waarde van eigenschap

Date

lockToken

Het vergrendelingstoken is een verwijzing naar de vergrendeling die wordt vastgehouden door de broker in peekLock ontvangstmodus. Vergrendelingen worden intern gebruikt om berichten te vereffenen, zoals wordt uitgelegd in de productdocumentatie in meer detail

• Niet van toepassing wanneer het bericht wordt ontvangen in receiveAndDelete ontvangstmodus. wijze.

lockToken?: string

Waarde van eigenschap

string

sequenceNumber

Het unieke nummer dat is toegewezen aan een bericht door Service Bus. Het volgnummer is een uniek 64-bits geheel getal dat is toegewezen aan een bericht omdat het wordt geaccepteerd en opgeslagen door de broker en fungeert als de ware id. Voor gepartitioneerde entiteiten weerspiegelen de bovenste 16 bits de partitie-id. De reeksnummers nemen monotonisch toe. Ze rollen over naar 0 wanneer het 48-64-bits bereik is uitgeput.

Max, veilig geheel getal dat momenteel door Javascript wordt ondersteund, is 2^53 - 1. Het volgnummer is een AMQP-Long type dat maximaal 64 bits lang kan zijn. Om aan te geven dat we een bibliotheek met de naam long.jsgebruiken. We verwachten dat klanten het Long type gebruiken dat door deze bibliotheek wordt geëxporteerd.

sequenceNumber?: Long

Waarde van eigenschap

Long

state

De status van het bericht kan actief, uitgesteld of gepland zijn. Uitgestelde berichten hebben de status uitgesteld, geplande berichten hebben de geplande status, alle andere berichten hebben de actieve status.

state: "active" | "deferred" | "scheduled"

Waarde van eigenschap

"active" | "deferred" | "scheduled"

Details van overgenomen eigenschap

applicationProperties

De toepassingsspecifieke eigenschappen die kunnen worden gebruikt voor aangepaste berichtmetagegevens.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

Waarde van eigenschap

{[key: string]: number | boolean | string | Date | null}

overgenomen vanServiceBusMessage.applicationProperties-

body

De hoofdtekst van het bericht dat moet worden verzonden of ontvangen. Als de toepassing die het bericht ontvangt, deze SDK niet gebruikt, converteert u de nettolading van uw hoofdtekst naar een bytematrix of buffer voor betere compatibiliteit tussen talen.

body: any

Waarde van eigenschap

any

overgenomen vanServiceBusMessage.body

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

overgenomen vanServiceBusMessage.contentType-

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. Zie berichtroutering en correlatie-.

correlationId?: string | number | Buffer

Waarde van eigenschap

string | number | Buffer

overgenomen vanServiceBusMessage.correlationId

messageId

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

Opmerking: getallen die geen gehele gehele getallen zijn, zijn niet toegestaan.

messageId?: string | number | Buffer

Waarde van eigenschap

string | number | Buffer

overgenomen vanServiceBusMessage.messageId

partitionKey

De partitiesleutel voor het verzenden van een bericht naar een gepartitioneerde entiteit. De maximale lengte is 128 tekens. Voor gepartitioneerde entiteitenkunt u met deze waarde gerelateerde berichten toewijzen aan dezelfde interne partitie, zodat de volgordevolgorde van de inzending correct wordt vastgelegd. De partitie wordt gekozen door een hash-functie boven deze waarde en kan niet rechtstreeks worden gekozen.

• Voor sessiebewuste entiteiten overschrijft de eigenschap sessionId deze waarde.
• Voor niet-gepartitioneerde entiteiten wordt de partitiesleutel genegeerd

partitionKey?: string

Waarde van eigenschap

string

overgenomen vanServiceBusMessage.partitionKey

replyTo

Het adres van een entiteit waarnaar antwoorden moeten worden verzonden. Deze optionele en toepassingsgedefinieerde waarde is een standaardmethode om een antwoordpad uit te drukken naar de ontvanger van het bericht. Wanneer een afzender een antwoord verwacht, wordt de waarde ingesteld op het absolute of relatieve pad van de wachtrij of het onderwerp waarnaar het antwoord wordt verzonden. Zie berichtroutering en correlatie-.

replyTo?: string

Waarde van eigenschap

string

overgenomen vanServiceBusMessage.replyTo

replyToSessionId

Met de sessie-id wordt het replyTo adres vergroot. De maximale lengte is 128 tekens. Deze waarde vergroot de replyTo-informatie en geeft aan welke SessionId moet worden ingesteld voor het antwoord wanneer deze naar de antwoordentiteit wordt verzonden. Zie berichtroutering en correlatie-.

replyToSessionId?: string

Waarde van eigenschap

string

overgenomen vanServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

De datum en tijd in UTC waarop het bericht wordt ge enqueued. Deze eigenschap retourneert de tijd in UTC; Bij het instellen van de eigenschap moet de opgegeven Datum/tijd-waarde ook in UTC staan. Deze waarde is bedoeld voor het verzenden van vertraagde berichten. Het wordt gebruikt om berichten die in de toekomst naar een bepaald tijdstip worden verzonden, uit te stellen. De tijd voor het enqueueren van berichten betekent niet dat het bericht tegelijkertijd wordt verzonden. Het wordt geïntenseueerd, maar de werkelijke verzendtijd is afhankelijk van de workload van de wachtrij en de status ervan.

scheduledEnqueueTimeUtc?: Date

Waarde van eigenschap

Date

overgenomen vanServiceBusMessage.scheduledEnqueueTimeUtc-

sessionId

De sessie-id voor een sessiebewuste entiteit. De maximale lengte is 128 tekens. Voor sessiebewuste entiteiten geeft deze toepassingsgedefinieerde waarde de sessierelatie van het bericht op. Berichten met dezelfde sessie-id zijn onderworpen aan samenvattingsvergrendeling en kunnen exact in-orderverwerking en demultiplexing inschakelen. Voor entiteiten die zich niet bewust zijn van de sessie, wordt deze waarde genegeerd. berichtsessies.

sessionId?: string

Waarde van eigenschap

string

overgenomen vanServiceBusMessage.sessionId

subject

Het toepassingsspecifieke label. Met deze eigenschap kan de toepassing het doel van het bericht aangeven aan de ontvanger in een gestandaardiseerde. mode, vergelijkbaar met een onderwerpregel voor e-mail. De toegewezen AMQP-eigenschap is 'subject'.

subject?: string

Waarde van eigenschap

string

overgenomen vanServiceBusMessage.subject

timeToLive

De time to live-waarde van het bericht. Deze waarde is de relatieve duur waarna het bericht verloopt, vanaf het chatbericht is geaccepteerd en opgeslagen door de broker, zoals vastgelegd in enqueuedTimeUtc. Als deze waarde niet expliciet is ingesteld, is de veronderstelde waarde de DefaultTimeToLive voor de respectieve wachtrij of het betreffende onderwerp. Een timeToLive waarde op berichtniveau kan niet langer zijn dan de instelling DefaultTimeToLive van de entiteit en wordt op de achtergrond aangepast als dit wel het geval is. Zie vervaldatum.

timeToLive?: number

Waarde van eigenschap

number

overgenomen vanServiceBusMessage.timeToLive-

to

Het adres 'aan'. Deze eigenschap is gereserveerd voor toekomstig gebruik in routeringsscenario's en wordt momenteel genegeerd door de broker zelf. Toepassingen kunnen deze waarde gebruiken in regelgestuurde automatisch koppelen scenario's om de beoogde logische bestemming van het bericht aan te geven.

to?: string

Waarde van eigenschap

string

overgenomen vanServiceBusMessage.to