ServiceBusReceivedMessage interface

Balíček:

@azure/service-bus

Popisuje zprávu přijatou službou Service Bus během operací náhledu, a proto ji nelze vyřešit.

Extends

ServiceBusMessage

Vlastnosti

deadLetterErrorDescription	Popis chyby pro nedoručení zprávy.
deadLetterReason	Důvod smrti zprávy.
deadLetterSource	Název fronty nebo odběru, ve které byla tato zpráva zařazena do fronty, před jejím zablokováním. Nastaví se jenom ve zprávách, které byly přeposlané a následně automaticky přeposílané z dílčí fronty nedoručených zpráv do jiné entity. Označuje entitu, ve které byla zpráva nedoručována.
deliveryCount	Počet dodávek, o které se tato zpráva pokusila. Počet se zvýší, když vyprší platnost zámku zprávy nebo je zpráva explicitně opuštěna pomocí metody abandon() ve zprávě.
enqueuedSequenceNumber	Původní pořadové číslo zprávy. U zpráv, které byly automaticky přeposílané, tato vlastnost odráží pořadové číslo, které bylo poprvé přiřazeno ke zprávě v původním okamžiku odeslání.
enqueuedTimeUtc	Okamžitě ve standardu UTC, ve kterém byla zpráva přijata a uložena ve službě Service Bus.
expiresAtUtc	Okamžitě ve standardu UTC, ve kterém je zpráva označena k odebrání a již není k dispozici pro načtení z entity kvůli vypršení platnosti. Tato vlastnost se vypočítá ze 2 dalších vlastností zprávy: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Čas UTC, do kterého se zpráva zamkne ve frontě nebo odběru Po vypršení platnosti zámku se deliveryCount zvýší a zpráva bude znovu k dispozici pro načtení. Nelze použít při přijetí zprávy v receiveAndDelete režimu příjmu. režim.
lockToken	Zámek tokenu je odkazem na zámek, který zprostředkovatel uchovává v režimu příjmu peekLock. Zámky se používají interně urovnávat zprávy, jak je vysvětleno v dokumentaci k produktu podrobněji Nelze použít při přijetí zprávy v receiveAndDelete režimu příjmu. režim.
sequenceNumber	Jedinečné číslo přiřazené ke zprávě službou Service Bus. Pořadové číslo je jedinečné 64bitové celé číslo přiřazené ke zprávě, protože je přijato a uloženo zprostředkovatelem a funguje jako jeho skutečný identifikátor. U dělených entit odráží identifikátor oddílu nejvíce 16 bitů. Sekvenční čísla se monotonicky zvyšují. Při vyčerpání 48-64bitového rozsahu se převrácejí na 0. Maximální bezpečné celé číslo, které JavaScript aktuálně podporuje, je 2^53 - 1. Pořadové číslo je typ AMQP Long, který může mít délku až 64 bitů. Abychom představovali, že používáme knihovnu s názvem long.js. Očekáváme, že zákazníci budou používat Long typ exportovaný touto knihovnou.
state	Stav zprávy může být aktivní, odložený nebo plánovaný. Odložené zprávy mají odložený stav, naplánované zprávy mají naplánovaný stav, všechny ostatní zprávy mají aktivní stav.

Zděděné vlastnosti

applicationProperties	Vlastnosti specifické pro aplikaci, které lze použít pro vlastní metadata zpráv.
body	Text zprávy, který musí být odeslán nebo přijat. Pokud aplikace, která zprávu obdrží, tuto sadu SDK nepoužívá, převeďte datovou část textu na pole bajtů nebo vyrovnávací paměť pro lepší kompatibilitu mezi jazyky.
contentType	Typ obsahu zprávy. Volitelně popisuje datovou část zprávy s popisovačem ve formátu RFC2045 oddílu 5, například "application/json".
correlationId	Identifikátor korelace, který aplikaci umožňuje zadat kontext zprávy pro účely korelace, například odrážející Id zprávy, na kterou se odpovídá. Viz směrování zpráv a korelace.
messageId	Identifikátor zprávy je hodnota definovaná aplikací, která jednoznačně identifikuje zprávu a její datovou část. Poznámka: Čísla, která nejsou celá celá čísla, nejsou povolená.
partitionKey	Klíč oddílu pro odeslání zprávy do dělené entity. Maximální délka je 128 znaků. Pro dělené entitynastavení této hodnoty umožňuje přiřazovat související zprávy do stejného interního oddílu, aby bylo správně zaznamenáno pořadí odeslání. Oddíl je zvolen funkcí hash nad touto hodnotou a nelze ho vybrat přímo. U entit pracujících s relacemi přepíše tato hodnota vlastnost sessionId. U nedělených entit se klíč oddílu bude ignorovat.
replyTo	Adresa entity, na kterou se mají odesílat odpovědi. Tato volitelná hodnota a hodnota definovaná aplikací je standardní způsob vyjádření cesty odpovědi příjemci zprávy. Když odesílatel očekává odpověď, nastaví hodnotu na absolutní nebo relativní cestu fronty nebo tématu, na kterou očekává odeslání odpovědi. Viz směrování zpráv a korelace.
replyToSessionId	Identifikátor relace, který rozšiřuje replyTo adresu. Maximální délka je 128 znaků. Tato hodnota rozšiřuje informace ReplyTo a určuje, které Id relace se má nastavit pro odpověď při odeslání do entity odpovědi. Viz směrování zpráv a korelace.
scheduledEnqueueTimeUtc	Datum a čas ve standardu UTC, ve kterém se zpráva zapíše do fronty. Tato vlastnost vrátí čas ve standardu UTC; při nastavování vlastnosti musí být zadaná hodnota DateTime také v UTC. Tato hodnota je určená pro zpožděné odesílání zpráv. V budoucnu se využívá ke zpoždění odesílání zpráv do určitého času. Čas zařazení zprávy do fronty neznamená, že zpráva bude odeslána současně. Zařadí se do fronty, ale skutečný čas odeslání závisí na úloze fronty a jeho stavu.
sessionId	Identifikátor relace pro entitu pracující s relací. Maximální délka je 128 znaků. U entit pracujících s relacemi určuje tato hodnota definovaná aplikací přidružení relace zprávy. Zprávy se stejným identifikátorem relace podléhají souhrnnému uzamčení a umožňují přesné zpracování v pořadí a demultiplexování. U entit, které nejsou v relaci, se tato hodnota ignoruje. relace zpráv.
subject	Popisek specifický pro aplikaci. Tato vlastnost umožňuje aplikaci označit účel zprávy příjemci ve standardizované. podobně jako řádek předmětu e-mailu. Mapovaná vlastnost AMQP je "subject".
timeToLive	Hodnota zprávy je čas naživu. Tato hodnota je relativní doba trvání, po které vyprší platnost zprávy, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zachyceno v enqueuedTimeUtc. Pokud není nastaven explicitně, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota timeToLive na úrovni zpráv nemůže být delší než nastavení DefaultTimeToLive entity a v případě potřeby se bezobslužně upraví. Viz vypršení platnosti.
to	Adresa komu. Tato vlastnost je vyhrazena pro budoucí použití ve scénářích směrování a v současnosti je ignorována samotným zprostředkovatelem. Aplikace můžou tuto hodnotu použít v automatickém přeposílání scénářích, které označují zamýšlený logický cíl zprávy.

Podrobnosti vlastnosti

deadLetterErrorDescription

Popis chyby pro nedoručení zprávy.

deadLetterErrorDescription?: string

Hodnota vlastnosti

string

deadLetterReason

Důvod smrti zprávy.

deadLetterReason?: string

Hodnota vlastnosti

string

deadLetterSource

Název fronty nebo odběru, ve které byla tato zpráva zařazena do fronty, před jejím zablokováním. Nastaví se jenom ve zprávách, které byly přeposlané a následně automaticky přeposílané z dílčí fronty nedoručených zpráv do jiné entity. Označuje entitu, ve které byla zpráva nedoručována.

deadLetterSource?: string

Hodnota vlastnosti

string

deliveryCount

Počet dodávek, o které se tato zpráva pokusila. Počet se zvýší, když vyprší platnost zámku zprávy nebo je zpráva explicitně opuštěna pomocí metody abandon() ve zprávě.

deliveryCount?: number

Hodnota vlastnosti

number

enqueuedSequenceNumber

Původní pořadové číslo zprávy. U zpráv, které byly automaticky přeposílané, tato vlastnost odráží pořadové číslo, které bylo poprvé přiřazeno ke zprávě v původním okamžiku odeslání.

enqueuedSequenceNumber?: number

Hodnota vlastnosti

number

enqueuedTimeUtc

Okamžitě ve standardu UTC, ve kterém byla zpráva přijata a uložena ve službě Service Bus.

enqueuedTimeUtc?: Date

Hodnota vlastnosti

Date

expiresAtUtc

Okamžitě ve standardu UTC, ve kterém je zpráva označena k odebrání a již není k dispozici pro načtení z entity kvůli vypršení platnosti. Tato vlastnost se vypočítá ze 2 dalších vlastností zprávy: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Hodnota vlastnosti

Date

lockedUntilUtc

Čas UTC, do kterého se zpráva zamkne ve frontě nebo odběru Po vypršení platnosti zámku se deliveryCount zvýší a zpráva bude znovu k dispozici pro načtení.

• Nelze použít při přijetí zprávy v receiveAndDelete režimu příjmu. režim.

lockedUntilUtc?: Date

Hodnota vlastnosti

Date

lockToken

Zámek tokenu je odkazem na zámek, který zprostředkovatel uchovává v režimu příjmu peekLock. Zámky se používají interně urovnávat zprávy, jak je vysvětleno v dokumentaci k produktu podrobněji

• Nelze použít při přijetí zprávy v receiveAndDelete režimu příjmu. režim.

lockToken?: string

Hodnota vlastnosti

string

sequenceNumber

Jedinečné číslo přiřazené ke zprávě službou Service Bus. Pořadové číslo je jedinečné 64bitové celé číslo přiřazené ke zprávě, protože je přijato a uloženo zprostředkovatelem a funguje jako jeho skutečný identifikátor. U dělených entit odráží identifikátor oddílu nejvíce 16 bitů. Sekvenční čísla se monotonicky zvyšují. Při vyčerpání 48-64bitového rozsahu se převrácejí na 0.

Maximální bezpečné celé číslo, které JavaScript aktuálně podporuje, je 2^53 - 1. Pořadové číslo je typ AMQP Long, který může mít délku až 64 bitů. Abychom představovali, že používáme knihovnu s názvem long.js. Očekáváme, že zákazníci budou používat Long typ exportovaný touto knihovnou.

sequenceNumber?: Long

Hodnota vlastnosti

Long

state

Stav zprávy může být aktivní, odložený nebo plánovaný. Odložené zprávy mají odložený stav, naplánované zprávy mají naplánovaný stav, všechny ostatní zprávy mají aktivní stav.

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

Hodnota vlastnosti

"active" | "deferred" | "scheduled"

Podrobnosti zděděných vlastností

applicationProperties

Vlastnosti specifické pro aplikaci, které lze použít pro vlastní metadata zpráv.

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

Hodnota vlastnosti

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

zděděno zeServiceBusMessage.applicationProperties

body

Text zprávy, který musí být odeslán nebo přijat. Pokud aplikace, která zprávu obdrží, tuto sadu SDK nepoužívá, převeďte datovou část textu na pole bajtů nebo vyrovnávací paměť pro lepší kompatibilitu mezi jazyky.

body: any

Hodnota vlastnosti

any

zděděno zServiceBusMessage.body

contentType

Typ obsahu zprávy. Volitelně popisuje datovou část zprávy s popisovačem ve formátu RFC2045 oddílu 5, například "application/json".

contentType?: string

Hodnota vlastnosti

string

zděděno zServiceBusMessage.contentType

correlationId

Identifikátor korelace, který aplikaci umožňuje zadat kontext zprávy pro účely korelace, například odrážející Id zprávy, na kterou se odpovídá. Viz směrování zpráv a korelace.

correlationId?: string | number | Buffer

Hodnota vlastnosti

string | number | Buffer

zděděno zServiceBusMessage.correlationId

messageId

Identifikátor zprávy je hodnota definovaná aplikací, která jednoznačně identifikuje zprávu a její datovou část.

Poznámka: Čísla, která nejsou celá celá čísla, nejsou povolená.

messageId?: string | number | Buffer

Hodnota vlastnosti

string | number | Buffer

zděděno zServiceBusMessage.messageId

partitionKey

Klíč oddílu pro odeslání zprávy do dělené entity. Maximální délka je 128 znaků. Pro dělené entitynastavení této hodnoty umožňuje přiřazovat související zprávy do stejného interního oddílu, aby bylo správně zaznamenáno pořadí odeslání. Oddíl je zvolen funkcí hash nad touto hodnotou a nelze ho vybrat přímo.

• U entit pracujících s relacemi přepíše tato hodnota vlastnost sessionId.
• U nedělených entit se klíč oddílu bude ignorovat.

partitionKey?: string

Hodnota vlastnosti

string

zděděný zServiceBusMessage.partitionKey

replyTo

Adresa entity, na kterou se mají odesílat odpovědi. Tato volitelná hodnota a hodnota definovaná aplikací je standardní způsob vyjádření cesty odpovědi příjemci zprávy. Když odesílatel očekává odpověď, nastaví hodnotu na absolutní nebo relativní cestu fronty nebo tématu, na kterou očekává odeslání odpovědi. Viz směrování zpráv a korelace.

replyTo?: string

Hodnota vlastnosti

string

zděděno zeServiceBusMessage.replyTo

replyToSessionId

Identifikátor relace, který rozšiřuje replyTo adresu. Maximální délka je 128 znaků. Tato hodnota rozšiřuje informace ReplyTo a určuje, které Id relace se má nastavit pro odpověď při odeslání do entity odpovědi. Viz směrování zpráv a korelace.

replyToSessionId?: string

Hodnota vlastnosti

string

zděděno zServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Datum a čas ve standardu UTC, ve kterém se zpráva zapíše do fronty. Tato vlastnost vrátí čas ve standardu UTC; při nastavování vlastnosti musí být zadaná hodnota DateTime také v UTC. Tato hodnota je určená pro zpožděné odesílání zpráv. V budoucnu se využívá ke zpoždění odesílání zpráv do určitého času. Čas zařazení zprávy do fronty neznamená, že zpráva bude odeslána současně. Zařadí se do fronty, ale skutečný čas odeslání závisí na úloze fronty a jeho stavu.

scheduledEnqueueTimeUtc?: Date

Hodnota vlastnosti

Date

zděděno zServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

Identifikátor relace pro entitu pracující s relací. Maximální délka je 128 znaků. U entit pracujících s relacemi určuje tato hodnota definovaná aplikací přidružení relace zprávy. Zprávy se stejným identifikátorem relace podléhají souhrnnému uzamčení a umožňují přesné zpracování v pořadí a demultiplexování. U entit, které nejsou v relaci, se tato hodnota ignoruje. relace zpráv.

sessionId?: string

Hodnota vlastnosti

string

zděděno zServiceBusMessage.sessionId

subject

Popisek specifický pro aplikaci. Tato vlastnost umožňuje aplikaci označit účel zprávy příjemci ve standardizované. podobně jako řádek předmětu e-mailu. Mapovaná vlastnost AMQP je "subject".

subject?: string

Hodnota vlastnosti

string

zděděno zeServiceBusMessage.subject

timeToLive

Hodnota zprávy je čas naživu. Tato hodnota je relativní doba trvání, po které vyprší platnost zprávy, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zachyceno v enqueuedTimeUtc. Pokud není nastaven explicitně, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota timeToLive na úrovni zpráv nemůže být delší než nastavení DefaultTimeToLive entity a v případě potřeby se bezobslužně upraví. Viz vypršení platnosti.

timeToLive?: number

Hodnota vlastnosti

number

zděděno zServiceBusMessage.timeToLive

to

Adresa komu. Tato vlastnost je vyhrazena pro budoucí použití ve scénářích směrování a v současnosti je ignorována samotným zprostředkovatelem. Aplikace můžou tuto hodnotu použít v automatickém přeposílání scénářích, které označují zamýšlený logický cíl zprávy.

to?: string

Hodnota vlastnosti

string

zděděno zServiceBusMessage.to