ServiceBusMessage Kelas
Pesan Bus Layanan.
- Warisan
-
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)
Parameter
- application_properties
- Dict[str, Union[int atau float atau bool atau bytes atau str atau UUID atau datetime atau None]]
Properti yang ditentukan pengguna pada pesan.
Contoh
Mengirim pesan dengan properti tambahan
message_send = ServiceBusMessage(
"Hello World!!",
session_id="MySessionID",
application_properties={'data': 'custom_data'},
time_to_live=datetime.timedelta(seconds=30),
label='MyLabel'
)
Atribut
application_properties
body
Isi Pesan. Format dapat bervariasi tergantung pada jenis isi: Untuk DATA, isinya bisa byte atau Iterable[byte]. Untuk SEQUENCE, isinya bisa Daftar atau Iterable[List]. Untuk VALUE, isinya bisa jenis apa saja.
Tipe hasil
body_type
content_type
Deskriptor tipe isi.
Secara opsional menjelaskan payload pesan, dengan deskriptor mengikuti format RFC2045, Bagian 5, misalnya "application/json".
Tipe hasil
correlation_id
Pengidentifikasi korelasi.
Memungkinkan aplikasi menentukan konteks untuk pesan untuk tujuan korelasi, misalnya mencerminkan MessageId pesan yang sedang dijawab.
Lihat Perutean dan Korelasi Pesan di https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Tipe hasil
message
Dapatkan uamqp yang mendasar. Pesan atau LegacyMessage. Ini tidak digunakan lagi dan akan dihapus dalam rilis selanjutnya.
Tipe hasil
message_id
Id untuk mengidentifikasi pesan.
Pengidentifikasi pesan adalah nilai yang ditentukan aplikasi yang secara unik mengidentifikasi pesan dan muatannya. Pengidentifikasi adalah string bentuk bebas dan dapat mencerminkan GUID atau pengidentifikasi yang berasal dari konteks aplikasi. Jika diaktifkan, fitur deteksi duplikat (lihat https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) mengidentifikasi dan menghapus pengiriman pesan kedua dan lebih lanjut dengan id pesan yang sama.
Tipe hasil
partition_key
Kunci partisi untuk mengirim pesan ke entitas yang dipartisi.
Mengatur nilai ini memungkinkan penetapan pesan terkait ke partisi internal yang sama, sehingga urutan pengiriman direkam dengan benar. Partisi dipilih oleh fungsi hash atas nilai ini dan tidak dapat dipilih secara langsung.
Lihat Antrean dan topik yang dipartisi di https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.
Tipe hasil
raw_amqp_message
Penggunaan tingkat lanjut saja. Payload pesan AMQP internal yang dikirim atau diterima. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage
reply_to
Alamat entitas yang akan dikirimi balasan.
Nilai opsional dan yang ditentukan aplikasi ini adalah cara standar untuk mengekspresikan jalur balasan ke penerima pesan. Ketika pengirim mengharapkan balasan, ini menetapkan nilai ke jalur absolut atau relatif dari antrean atau topik yang diharapkan balasan akan dikirim.
Lihat Perutean dan Korelasi Pesan di https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Tipe hasil
reply_to_session_id
Pengidentifikasi sesi menambah alamat reply_to .
Nilai ini menambah informasi reply_to dan menentukan id sesi mana yang harus ditetapkan untuk balasan saat dikirim ke entitas balasan.
Lihat Perutean dan Korelasi Pesan di https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.
Tipe hasil
scheduled_enqueue_time_utc
Waktu antrean terjadwal utc ke pesan.
Properti ini dapat digunakan untuk penjadwalan saat mengirim pesan melalui metode ServiceBusSender.send . Jika membatalkan pesan terjadwal diperlukan, Anda harus menggunakan metode ServiceBusSender.schedule , yang mengembalikan nomor urut yang dapat digunakan untuk pembatalan di masa mendatang. scheduled_enqueue_time_utc Tidak Ada jika tidak diatur.
Tipe hasil
session_id
Pengidentifikasi sesi pesan untuk entitas sesi.
Untuk entitas sesi, nilai yang ditentukan aplikasi ini menentukan afiliasi sesi pesan. Pesan dengan pengidentifikasi sesi yang sama tunduk pada penguncian ringkasan dan mengaktifkan pemrosesan dan demultiplexing dalam urutan yang tepat. Untuk entitas yang tidak sesi, nilai ini diabaikan.
Lihat Sesi Pesan di https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.
Tipe hasil
subject
Subjek spesifik aplikasi, terkadang disebut sebagai label.
Properti ini memungkinkan aplikasi untuk menunjukkan tujuan pesan ke penerima dengan cara standar, mirip dengan baris subjek email.
Tipe hasil
time_to_live
Durasi hidup pesan.
Nilai ini adalah durasi relatif setelah pesan kedaluwarsa, mulai dari instan pesan telah diterima dan disimpan oleh broker, seperti yang diambil dalam enqueued_time_utc. Ketika tidak diatur secara eksplisit, nilai yang diasumsikan adalah DefaultTimeToLive untuk masing-masing antrean atau topik. Nilai time-to-live tingkat pesan tidak boleh lebih panjang dari pengaturan time-to-live entitas dan disesuaikan secara diam-diam jika itu terjadi.
Lihat Kedaluwarsa di https://docs.microsoft.com/azure/service-bus-messaging/message-expiration
Tipe hasil
to
Alamat ke .
Properti ini disediakan untuk digunakan di masa mendatang dalam skenario perutean dan saat ini diabaikan oleh broker itu sendiri. Aplikasi dapat menggunakan nilai ini dalam skenario rantai penerusan otomatis berbasis aturan untuk menunjukkan tujuan logis pesan yang dimaksudkan.
Lihat https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding untuk detail selengkapnya.
Tipe hasil
Azure SDK for Python
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk