ServiceBusReceivedMessage Třída

Zpráva služby Service Bus přijatá ze strany služby

Dědičnost

azure.servicebus._common.message.ServiceBusMessage

ServiceBusReceivedMessage

Konstruktor

ServiceBusReceivedMessage(message: 'Message' | 'pyamqp_Message', receive_mode: ServiceBusReceiveMode | str = ServiceBusReceiveMode.PEEK_LOCK, frame: 'TransferFrame' | None = None, **kwargs: Any)

Parametry

Name	Description
message Vyžadováno
receive_mode	výchozí hodnota: ServiceBusReceiveMode.PEEK_LOCK
frame	výchozí hodnota: None

Příklady

Kontrola vlastností přijaté zprávy

       from typing import List
       from azure.servicebus import ServiceBusReceivedMessage
       messages_complex: List[ServiceBusReceivedMessage] = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages_complex:
           print("Receiving: {}".format(message))
           print("Time to live: {}".format(message.time_to_live))
           print("Sequence number: {}".format(message.sequence_number))
           print("Enqueued Sequence number: {}".format(message.enqueued_sequence_number))
           print("Partition Key: {}".format(message.partition_key))
           print("Application Properties: {}".format(message.application_properties))
           print("Delivery count: {}".format(message.delivery_count))
           print("Message ID: {}".format(message.message_id))
           print("Locked until: {}".format(message.locked_until_utc))
           print("Lock Token: {}".format(message.lock_token))
           print("Enqueued time: {}".format(message.enqueued_time_utc))

Proměnné

Name	Description
auto_renew_error	<xref:azure.servicebus.AutoLockRenewTimeout> nebo <xref:azure.servicebus.AutoLockRenewFailed> Chyba při použití funkce AutoLockRenewer a nepodaří se obnovit zámek zpráv.

Atributy

application_properties

Uživatelem definované vlastnosti zprávy.

Návraty

Typ	Description
dict[str, bytes, <xref:PrimitiveTypes>], None

body

Text zprávy. Formát se může lišit v závislosti na typu textu: Pro DATAmůže být tělo bajty nebo iterable[bajty]. Text SEQUENCEmůže být List nebo Iterable[List]. V VALUEpřípadě může být tělo libovolného typu.

Návraty

Typ	Description
Any

body_type

Typ textu podkladové zprávy AMQP.

Návraty

Typ	Description
AmqpMessageBodyType

content_type

Popisovač typu obsahu.

Volitelně popisuje datovou část zprávy, přičemž popisovač následuje za formátem RFC2045, Oddíl 5, například application/json.

Návraty

Typ	Description
str, None

correlation_id

Identifikátor korelace.

Umožňuje aplikaci zadat kontext zprávy pro účely korelace, například odrážet MessageId zprávy, na kterou odpovídáte.

Viz Směrování a korelace zpráv v https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlationnástroji .

Návraty

Typ	Description
str, None

dead_letter_error_description

Popis chyby nedoručených zpráv, když je zpráva přijata z podpřísadky deadletter entity.

Návraty

Typ	Description
str

dead_letter_reason

Důvod nedoručené zprávy, když je zpráva přijata z podpřísadky deadletter entity.

Návraty

Typ	Description
str

dead_letter_source

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

Návraty

Typ	Description
str

delivery_count

Počet pokusů o doručení této zprávy Počet se navyšuje, když vyprší platnost zámku zprávy nebo příjemce zprávu explicitně opustí.

Návraty

Typ	Description
int

enqueued_sequence_number

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í.

Návraty

Typ	Description
int

enqueued_time_utc

Datum a čas UTC, kdy byla zpráva přijata a uložena v entitě.

Návraty

Typ	Description
datetime

expires_at_utc

Datum a čas UTC, kdy je zpráva označena k odebrání a kvůli vypršení platnosti už není k dispozici pro načtení z entity. Vypršení platnosti se řídí vlastností Message.time_to_live . Tato vlastnost se vypočítá z Message.enqueued_time_utc + Message.time_to_live.

Návraty

Typ	Description
datetime

lock_token

Token zámku pro aktuální zprávu, který slouží jako odkaz na zámek, který zprostředkovatel drží v PEEK_LOCK režimu.

Návraty

Typ	Description
UUID, str

locked_until_utc

Datum a čas UTC, do kterého bude zpráva uzamčena ve frontě nebo odběru. Po vypršení platnosti zámku se počet doručení zprávy zvýší a zpráva bude znovu k dispozici pro načtení.

Návraty

Typ	Description
datetime

message

Získejte základní LegacyMessage. Tato možnost je zastaralá a v pozdější verzi se odebere.

Návraty

Typ	Description
<xref:LegacyMessage>

message_id

ID pro identifikaci zprávy.

Identifikátor zprávy je hodnota definovaná aplikací, která jednoznačně identifikuje zprávu a její datovou část. Identifikátor je řetězec volného tvaru a může odrážet identifikátor GUID nebo identifikátor odvozený z kontextu aplikace. Pokud je tato funkce povolená, funkce zjišťování duplicit (viz https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) identifikuje a odebere druhé a další odeslání zpráv se stejným ID zprávy.

Návraty

Typ	Description
str, None

partition_key

Klíč oddílu pro odeslání zprávy do dělené entity.

Nastavení této hodnoty umožní přiřazovat související zprávy ke stejnému internímu oddílu, aby se pořadí pořadí odesílání správně zaznamenalo. Oddíl je zvolen funkcí hash nad touto hodnotou a nelze ho zvolit přímo.

Viz Dělené fronty a témata v https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.

Návraty

Typ	Description
str, None

raw_amqp_message

Pouze rozšířené využití. Interní datová část zprávy AMQP, která je odeslána nebo přijata. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

Adresa entity, do které se mají posílat odpovědi.

Tato volitelná a aplikace definovaná hodnota představuje standardní způsob, jak vyjádřit cestu odpovědi příjemci zprávy. Když odesílatel očekává odpověď, nastaví hodnotu absolutní nebo relativní cesty k frontě nebo tématu, do které očekává odeslání odpovědi.

Viz Směrování a korelace zpráv v https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlationnástroji .

Návraty

Typ	Description
str, None

reply_to_session_id

Identifikátor relace rozšiřující reply_to adresu.

Tato hodnota rozšiřuje reply_to informace 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 v https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlationnástroji .

Návraty

Typ	Description
str, None

scheduled_enqueue_time_utc

Čas zařazení zprávy do fronty naplánovaný ve formátu UTC.

Tuto vlastnost lze použít pro plánování při odesílání zprávy prostřednictvím metody ServiceBusSender.send . Pokud se vyžaduje zrušení naplánovaných zpráv, měli byste použít metodu ServiceBusSender.schedule , která vrací pořadová čísla, která lze použít pro budoucí zrušení. scheduled_enqueue_time_utc je Hodnota Žádná, pokud není nastavená.

Návraty

Typ	Description
datetime

sequence_number

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.

Návraty

Typ	Description
int

session_id

Identifikátor relace zprávy pro entitu s obsahem relace.

U entit 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é nejsou určené relacemi, se tato hodnota ignoruje.

Viz Relace zpráv v https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.

Návraty

Typ	Description
str, None

state

Výchozí hodnota je Aktivní. Představuje stav zprávy. Může být aktivní, deferred. nebo Naplánované.

Návraty

Typ	Description
ServiceBusMessageState

subject

Předmět specifický pro aplikaci, někdy označovaný jako popisek.

Tato vlastnost umožňuje aplikaci označit účel zprávy příjemci standardizovaným způsobem, podobně jako řádek předmětu e-mailu.

Návraty

Typ	Description
str

time_to_live

Doba života 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 zachycena v enqueued_time_utc. Pokud není explicitně nastavena, předpokládaná hodnota je DefaultTimeToLive pro příslušnou frontu nebo téma. Hodnota time-to-live na úrovni zprávy nemůže být delší než nastavení time-to-live entity, a pokud ano, upraví se tiše.

Viz Vypršení platnosti v https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Návraty

Typ	Description
timedelta

to

Adresa příjemce .

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.

Další podrobnosti najdete https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding v tématu .

Návraty

Typ	Description
str, None