ServiceBusReceivedMessage interface

Balíček:

@azure/service-bus

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

Extends

ServiceBusMessage

Vlastnosti

deadLetterErrorDescription	Popis chyby pro deadlettering zprávy.
deadLetterReason	Důvod pro deadlettering zprávy.
deadLetterSource	Název fronty nebo odběru, pro který byla tato zpráva zařazena do fronty před jejím zablokováním. Nastaveno pouze ve zprávách, které byly nedoručené a následně automaticky přeposílané z dílčí fronty nedoručených zpráv na jinou entitu. Označuje entitu, ve které byla zpráva nedoručených zpráv.
deliveryCount	Počet pokusů o doručení této zprávy Počet se při vypršení platnosti zámku zprávy nebo při explicitním opuštění zprávy pomocí abandon() metody ve zprávě zvýšit počet.
enqueuedSequenceNumber	Původní pořadové číslo zprávy. U zpráv, které byly automaticky přeposlány, tato vlastnost odráží pořadové číslo, které bylo poprvé přiřazeno ke zprávě v jejím původním okamžiku odeslání.
enqueuedTimeUtc	Instant (UTC), ve kterém byla zpráva přijata a uložena ve službě Service Bus.
expiresAtUtc	Instant UTC, ve kterém je zpráva označena k odebrání a již není k dispozici pro načtení z entity z důvodu vypršení platnosti. Tato vlastnost se vypočítá ze 2 dalších vlastností zprávy: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Instant UTC, do kterého se zpráva drží zamknutá ve frontě nebo odběru. Po vypršení platnosti deliveryCount zámku se hodnota navýší a zpráva je znovu k dispozici pro načtení. Nelze použít, pokud je zpráva přijata v receiveAndDelete režimu příjmu. Režimu.
lockToken	Token zámku je odkazem na zámek, který zprostředkovatel drží v peekLock režimu příjmu. Zámky se používají interně vyrovnávají zprávy, jak je podrobněji vysvětleno v dokumentaci k produktu. Nelze použít, pokud je zpráva přijata v receiveAndDelete režimu příjmu. Režimu.
sequenceNumber	Jedinečné číslo přiřazené zprávě službou Service Bus. Pořadové číslo je jedinečné 64bitové celé číslo přiřazené zprávě, protože je přijímáno a ukládáno zprostředkovatelem a funkce jako její identifikátor true. U dělených entit nejvyšších 16 bitů odpovídá identifikátor oddílu. Pořadová čísla monotónně rostou. Při vyčerpání 48-64bitového rozsahu se převalují 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ů. K vyjádření toho, že používáme knihovnu s názvemlong.js. Očekáváme, že zákazníci použijí Long typ exportovaný touto knihovnou.
state	Stav zprávy může být aktivní, odložený nebo naplánovaný. Odložené zprávy mají odložený stav, naplánované zprávy mají naplánovaný stav a 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, kterou je potřeba odeslat nebo která je přijata. Pokud aplikace přijímající zprávu tuto sadu SDK nepoužívá, převeďte datovou část těla na pole bajtů nebo vyrovnávací paměť, aby se zlepšila kompatibilita mezi jazyky.
contentType	Typ obsahu zprávy. Volitelně popisuje datovou část zprávy s popisovačem za formátem RFC2045, Oddíl 5, například "application/json".
correlationId	Identifikátor korelace, který umožňuje aplikaci zadat kontext zprávy pro účely korelace, například odráží MessageId zprávy, na kterou odpovídáte. Viz Směrování a korelace zpráv.
messageId	Identifikátor zprávy je hodnota definovaná aplikací, která jedinečně identifikuje zprávu a její datovou část. Poznámka: Čísla, která nejsou celá celá čísla, nejsou povolena.
partitionKey	Klíč oddílu pro odeslání zprávy do rozdělené entity. Maximální délka je 128 znaků. U dělených entit umožňuje nastavení této hodnoty přiřazovat související zprávy ke stejnému internímu oddílu, aby bylo pořadí odeslání správně zaznamenáno. Oddíl je zvolen hashovací funkcí nad touto hodnotou a nelze ho zvolit přímo. U entit pracujících s relacemi sessionId vlastnost tuto hodnotu přepíše. U nedělených entit se klíč oddílu ignoruje.
replyTo	Adresa entity, na kterou chcete odesílat odpovědi. Tato volitelná a aplikacemi definovaná hodnota představuje 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 k frontě nebo tématu, do které očekává odeslání odpovědi. Viz Směrování a korelace zpráv.
replyToSessionId	Identifikátor relace, který replyTo rozšiřuje 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í a korelace zpráv.
scheduledEnqueueTimeUtc	Datum a čas ve standardu UTC, kdy bude zpráva zapsána do fronty. Tato vlastnost vrátí čas v UTC; při nastavování vlastnosti musí být zadaná hodnota DateTime také v UTC. Tato hodnota je určena pro zpožděné odesílání zpráv. Používá se ke zpoždění odesílání zpráv do určitého času v budoucnu. Čas vytvoření fronty zpráv neznamená, že zpráva bude odeslána ve stejnou dobu. Zařadí se do fronty, ale skutečná doba odeslání závisí na zatížení fronty a jejím stavu.
sessionId	Identifikátor relace pro entitu pracující s relacemi. Maximální délka je 128 znaků. U entit pracujících s relacemi tato hodnota definovaná aplikací určuje 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é nevědí o relacích, se tato hodnota ignoruje. Relace zpráv.
subject	Popisek specifický pro aplikaci. Tato vlastnost umožňuje aplikaci označit účel zprávy pro příjemce ve standardizovaném. obdoba řádku předmětu e-mailu. Mapovaná vlastnost AMQP je subject.
timeToLive	Hodnota time to live zprávy. Tato hodnota je relativní doba trvání, po které zpráva vyprší, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zachyceno v enqueuedTimeUtc. Pokud není explicitně nastavena, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota na úrovni timeToLive zprávy nemůže být delší než nastavení DefaultTimeToLive entity, a pokud ano, upraví se tiše. 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časné době je ignorována samotným zprostředkovatelem. Aplikace mohou tuto hodnotu použít ve scénářích automatického dopředného řetězení řízeného pravidly k označení zamýšleného logického cíle zprávy.

Podrobnosti vlastnosti

deadLetterErrorDescription

Popis chyby pro deadlettering zprávy.

deadLetterErrorDescription?: string

Hodnota vlastnosti

string

deadLetterReason

Důvod pro deadlettering zprávy.

deadLetterReason?: string

Hodnota vlastnosti

string

deadLetterSource

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

deadLetterSource?: string

Hodnota vlastnosti

string

deliveryCount

Počet pokusů o doručení této zprávy Počet se při vypršení platnosti zámku zprávy nebo při explicitním opuštění zprávy pomocí abandon() metody ve zprávě zvýšit počet.

deliveryCount?: number

Hodnota vlastnosti

number

enqueuedSequenceNumber

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

enqueuedSequenceNumber?: number

Hodnota vlastnosti

number

enqueuedTimeUtc

Instant (UTC), ve kterém byla zpráva přijata a uložena ve službě Service Bus.

enqueuedTimeUtc?: Date

Hodnota vlastnosti

Date

expiresAtUtc

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

expiresAtUtc?: Date

Hodnota vlastnosti

Date

lockedUntilUtc

Instant UTC, do kterého se zpráva drží zamknutá ve frontě nebo odběru. Po vypršení platnosti deliveryCount zámku se hodnota navýší a zpráva je znovu k dispozici pro načtení.

• Nelze použít, pokud je zpráva přijata v receiveAndDelete režimu příjmu. Režimu.

lockedUntilUtc?: Date

Hodnota vlastnosti

Date

lockToken

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

• Nelze použít, pokud je zpráva přijata v receiveAndDelete režimu příjmu. Režimu.

lockToken?: string

Hodnota vlastnosti

string

sequenceNumber

Jedinečné číslo přiřazené zprávě službou Service Bus. Pořadové číslo je jedinečné 64bitové celé číslo přiřazené zprávě, protože je přijímáno a ukládáno zprostředkovatelem a funkce jako její identifikátor true. U dělených entit nejvyšších 16 bitů odpovídá identifikátor oddílu. Pořadová čísla monotónně rostou. Při vyčerpání 48-64bitového rozsahu se převalují 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ů. K vyjádření toho, že používáme knihovnu s názvemlong.js. Očekáváme, že zákazníci použijí Long typ exportovaný touto knihovnou.

sequenceNumber?: Long

Hodnota vlastnosti

Long

state

Stav zprávy může být aktivní, odložený nebo naplánovaný. Odložené zprávy mají odložený stav, naplánované zprávy mají naplánovaný stav a 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 zServiceBusMessage.applicationProperties

body

Text zprávy, kterou je potřeba odeslat nebo která je přijata. Pokud aplikace přijímající zprávu tuto sadu SDK nepoužívá, převeďte datovou část těla na pole bajtů nebo vyrovnávací paměť, aby se zlepšila kompatibilita 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 za formátem RFC2045, Oddíl 5, například "application/json".

contentType?: string

Hodnota vlastnosti

string

Zděděno zServiceBusMessage.contentType

correlationId

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

correlationId?: string | number | Buffer

Hodnota vlastnosti

string | number | Buffer

Zděděno zServiceBusMessage.correlationId

messageId

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

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

messageId?: string | number | Buffer

Hodnota vlastnosti

string | number | Buffer

Zděděno zServiceBusMessage.messageId

partitionKey

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

• U entit pracujících s relacemi sessionId vlastnost tuto hodnotu přepíše.
• U nedělených entit se klíč oddílu ignoruje.

partitionKey?: string

Hodnota vlastnosti

string

Zděděno zServiceBusMessage.partitionKey

replyTo

Adresa entity, na kterou chcete odesílat odpovědi. Tato volitelná a aplikacemi definovaná hodnota představuje 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 k frontě nebo tématu, do které očekává odeslání odpovědi. Viz Směrování a korelace zpráv.

replyTo?: string

Hodnota vlastnosti

string

Zděděno zServiceBusMessage.replyTo

replyToSessionId

Identifikátor relace, který replyTo rozšiřuje 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í a korelace zpráv.

replyToSessionId?: string

Hodnota vlastnosti

string

Zděděno zServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Datum a čas ve standardu UTC, kdy bude zpráva zapsána do fronty. Tato vlastnost vrátí čas v UTC; při nastavování vlastnosti musí být zadaná hodnota DateTime také v UTC. Tato hodnota je určena pro zpožděné odesílání zpráv. Používá se ke zpoždění odesílání zpráv do určitého času v budoucnu. Čas vytvoření fronty zpráv neznamená, že zpráva bude odeslána ve stejnou dobu. Zařadí se do fronty, ale skutečná doba odeslání závisí na zatížení fronty a jejím stavu.

scheduledEnqueueTimeUtc?: Date

Hodnota vlastnosti

Date

Zděděno zServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

Identifikátor relace pro entitu pracující s relacemi. Maximální délka je 128 znaků. U entit pracujících s relacemi tato hodnota definovaná aplikací určuje 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é nevědí o relacích, 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 pro příjemce ve standardizovaném. obdoba řádku předmětu e-mailu. Mapovaná vlastnost AMQP je subject.

subject?: string

Hodnota vlastnosti

string

Zděděno zeServiceBusMessage.subject

timeToLive

Hodnota time to live zprávy. Tato hodnota je relativní doba trvání, po které zpráva vyprší, počínaje okamžikem, kdy byla zpráva přijata a uložena zprostředkovatelem, jak je zachyceno v enqueuedTimeUtc. Pokud není explicitně nastavena, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota na úrovni timeToLive zprávy nemůže být delší než nastavení DefaultTimeToLive entity, a pokud ano, upraví se tiše. 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časné době je ignorována samotným zprostředkovatelem. Aplikace mohou tuto hodnotu použít ve scénářích automatického dopředného řetězení řízeného pravidly k označení zamýšleného logického cíle zprávy.

to?: string

Hodnota vlastnosti

string

Zděděno zServiceBusMessage.to