ServiceBusMessage Osztály

Service Bus-üzenet.

Öröklődés

builtins.object

ServiceBusMessage

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)

Paraméterek

body

Optional[Union[str, bytes]]

Kötelező

Az egyetlen üzenetben küldendő adatok.

application_properties

Dict[str, Union[int vagy float vagy bool vagy bytes vagy str vagy UUID vagy datetime vagy None]]

A felhasználó definiálta az üzenet tulajdonságait.

session_id

Optional[str]

Egy munkamenet-entitás üzenetének munkamenet-azonosítója.

message_id

Optional[str]

Az üzenet azonosítására szolgáló azonosító.

scheduled_enqueue_time_utc

Optional[datetime]

Az üzenet utc-beütemezett beiktatási ideje.

time_to_live

Optional[timedelta]

Az üzenet élettartama.

content_type

Optional[str]

A tartalomtípus-leíró.

correlation_id

Optional[str]

A korrelációs azonosító.

subject

Optional[str]

Az alkalmazásspecifikus téma, más néven címke.

partition_key

Optional[str]

Az üzenet particionált entitásnak való küldéséhez használt partíciókulcs.

to

Optional[str]

A auto_forward láncolásos forgatókönyvekhez használt cím.

reply_to

Optional[str]

Annak az entitásnak a címe, amelynek válaszokat szeretne küldeni.

reply_to_session_id

Optional[str]

A reply_to címet kiegészítő munkamenet-azonosító.

Példák

Üzenet küldése további tulajdonságokkal

   message_send = ServiceBusMessage(
       "Hello World!!",
       session_id="MySessionID",
       application_properties={'data': 'custom_data'},
       time_to_live=datetime.timedelta(seconds=30),
       label='MyLabel'
   )

Attribútumok

application_properties

A felhasználó definiálta az üzenet tulajdonságait.

Visszatérési típus

dict[str,

bytes, <xref:PrimitiveTypes>],

None

body

Az üzenet törzse. A formátum a törzs típusától függően változhat: a DATAesetében a törzs lehet bájt vagy Iterable[bájt]. A esetében SEQUENCEa törzs lehet List vagy Iterable[List]. A esetében VALUEa test bármilyen típusú lehet.

Visszatérési típus

Any

body_type

A mögöttes AMQP-üzenet törzstípusa.

Visszatérési típus

AmqpMessageBodyType

content_type

A tartalomtípus-leíró.

Ha szeretné, az üzenet hasznos adatait is leírja, egy leíróval, amely a RFC2045 5. szakaszának formátumát követi, például "application/json".

Visszatérési típus

str,

None

correlation_id

A korrelációs azonosító.

Lehetővé teszi, hogy az alkalmazások korreláció céljából megadják az üzenet kontextusát, például egy megválaszolt üzenet MessageId azonosítóját.

Lásd: Üzenetirányítás és korreláció a következőben https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation: .

Visszatérési típus

str,

None

message

Szerezze be a mögöttes uamqp-t. Üzenet vagy LegacyMessage. Ez elavult, és egy későbbi kiadásban el lesz távolítva.

Visszatérési típus

<xref:uamqp.Message>,

<xref:LegacyMessage>

message_id

Az üzenet azonosítására szolgáló azonosító.

Az üzenetazonosító egy alkalmazás által definiált érték, amely egyedileg azonosítja az üzenetet és annak hasznos adatait. Az azonosító egy szabad formátumú sztring, amely az alkalmazáskörnyezetből származó GUID-t vagy azonosítót tükrözhet. Ha engedélyezve van, a duplikátumészlelés (lásd https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) funkció azonosítja és eltávolítja az azonos üzenetazonosítóval rendelkező üzenetek második és további küldését.

Visszatérési típus

str,

None

partition_key

Az üzenet particionált entitásnak való küldéséhez használt partíciókulcs.

Ennek az értéknek a beállítása lehetővé teszi a kapcsolódó üzenetek hozzárendelését ugyanahhoz a belső partícióhoz, hogy a küldési sorrend helyesen legyen rögzítve. A partíciót egy kivonatfüggvény választja ki ezen az értéken, és nem választható ki közvetlenül.

Lásd: Particionált üzenetsorok és témakörök a következőben https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning: .

Visszatérési típus

str,

None

raw_amqp_message

Csak speciális használat. Az elküldött vagy fogadott belső AMQP-üzenet hasznos adatai. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

Annak az entitásnak a címe, amelynek válaszokat szeretne küldeni.

Ez az opcionális és alkalmazás által definiált érték szabványos módszer az üzenet címzettjének küldött válaszútvonal kifejezésére. Amikor egy feladó választ vár, az értéket annak az üzenetsornak vagy témakörnek az abszolút vagy relatív elérési útjára állítja be, amelyre a választ el szeretné küldeni.

Lásd: Üzenetirányítás és korreláció a következőben https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation: .

Visszatérési típus

str,

None

reply_to_session_id

A reply_to címet kiegészítő munkamenet-azonosító.

Ez az érték kibővíti a reply_to adatokat, és megadja, hogy a válasz entitásnak küldött válaszhoz melyik munkamenet-azonosítót kell beállítani.

Lásd: Üzenetirányítás és korreláció a következőben https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation: .

Visszatérési típus

str,

None

scheduled_enqueue_time_utc

Az üzenet utc-beütemezett beiktatási ideje.

Ez a tulajdonság használható az üzenetek ServiceBusSender.send metóduson keresztüli küldésekor történő ütemezéshez. Ha az ütemezett üzenetek törlésére van szükség, a ServiceBusSender.schedule metódust kell használnia, amely a jövőbeli lemondáshoz használható sorszámokat adja vissza. scheduled_enqueue_time_utc Nincs, ha nincs beállítva.

Visszatérési típus

datetime

session_id

Egy munkamenet-entitás üzenetének munkamenet-azonosítója.

Munkamenet-entitások esetén ez az alkalmazás által definiált érték határozza meg az üzenet munkamenet-kapcsolatát. Az azonos munkamenet-azonosítóval rendelkező üzenetekre összefoglaló zárolás vonatkozik, és lehetővé teszi a pontos sorrendben történő feldolgozást és demultiplexinget. A nem munkamenet-alapú entitások esetében a rendszer figyelmen kívül hagyja ezt az értéket.

Lásd: Üzenet-munkamenetek a következőben https://docs.microsoft.com/azure/service-bus-messaging/message-sessions: .

Visszatérési típus

str,

None

subject

Az alkalmazásspecifikus téma, más néven címke.

Ez a tulajdonság lehetővé teszi, hogy az alkalmazás szabványosított módon jelezze az üzenet célját a fogadónak, hasonlóan az e-mail tárgysorához.

Visszatérési típus

str

time_to_live

Az üzenet élettartama.

Ez az érték az a relatív időtartam, amely után az üzenet lejár, attól a pillanattól kezdve, amikor a közvetítő elfogadta és tárolta az üzenetet a enqueued_time_utc rögzített módon. Ha nincs explicit módon beállítva, a feltételezett érték a megfelelő üzenetsor vagy témakör DefaultTimeToLive értéke. Az üzenetszintű élettartam értéke nem lehet hosszabb, mint az entitás élettartam-beállítása, és ha igen, csendesen módosul.

Lásd: Lejárat a következőben: https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Visszatérési típus

timedelta

to

A címzett.

Ezt a tulajdonságot az útválasztási forgatókönyvek későbbi használatra fenntartják, és a közvetítő jelenleg figyelmen kívül hagyja. Az alkalmazások ezt az értéket szabályalapú automatikus továbbítási láncolásos forgatókönyvekben használhatják az üzenet kívánt logikai céljának jelzésére.

További részletekért lásd https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding : .

Visszatérési típus

str,

None