ServiceBusMessage Třída
Zpráva služby Service Bus.
- Dědičnost
-
builtins.objectServiceBusMessage
Konstruktor
ServiceBusMessage(body: str | bytes | None, *, application_properties: Dict[str | bytes, int | float | bytes | bool | str | UUID] | None = None, session_id: str | None = None, message_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, time_to_live: timedelta | None = None, content_type: str | None = None, correlation_id: str | None = None, subject: str | None = None, partition_key: str | None = None, to: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, **kwargs: Any)Parametry
- application_properties
- Dict[str, Union[int nebo float nebo bool nebo bytes nebo str nebo UUID nebo datetime nebo None]]
Uživatelem definované vlastnosti zprávy.
Čas zařazení zprávy do fronty naplánovaný ve formátu UTC.
Příklady
Odeslání zprávy s dalšími vlastnostmi
message_send = ServiceBusMessage(
"Hello World!!",
session_id="MySessionID",
application_properties={'data': 'custom_data'},
time_to_live=datetime.timedelta(seconds=30),
label='MyLabel'
)
Atributy
application_properties
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ávratový typ
body_type
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ávratový typ
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ávratový typ
message
Získejte základní uamqp. Message nebo LegacyMessage. Tato možnost je zastaralá a v pozdější verzi se odebere.
Návratový typ
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ávratový typ
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ávratový typ
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ávratový typ
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ávratový typ
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ávratový typ
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ávratový typ
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ávratový typ
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ávratový typ
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ávratový typ
Azure SDK for Python