Bagikan melalui

ServiceBusReceivedMessage Kelas

  • Referensi

Pesan Bus Layanan diterima dari sisi layanan.

Warisan
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)

Parameter

Nama Deskripsi
message
Diperlukan
receive_mode
Nilai default: ServiceBusReceiveMode.PEEK_LOCK
frame
Nilai default: None

Contoh

Memeriksa properti pada pesan yang diterima.


       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))

Variabel

Nama Deskripsi
auto_renew_error
<xref:azure.servicebus.AutoLockRenewTimeout> atau <xref:azure.servicebus.AutoLockRenewFailed>

Kesalahan saat AutoLockRenewer digunakan dan gagal memperbarui kunci pesan.

Atribut

application_properties

Properti yang ditentukan pengguna pada pesan.

Mengembalikan

Jenis Deskripsi
dict[str,
bytes, <xref:PrimitiveTypes>],
None

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.

Mengembalikan

Jenis Deskripsi
Any

body_type

Jenis isi pesan AMQP yang mendasar.

Mengembalikan

Jenis Deskripsi
AmqpMessageBodyType

content_type

Deskriptor tipe isi.

Secara opsional menjelaskan payload pesan, dengan deskriptor mengikuti format RFC2045, Bagian 5, misalnya "application/json".

Mengembalikan

Jenis Deskripsi
str,
None

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.

Mengembalikan

Jenis Deskripsi
str,
None

dead_letter_error_description

Deskripsi kesalahan surat mati, ketika pesan diterima dari sub-antrean deadletter entitas.

Mengembalikan

Jenis Deskripsi
str

dead_letter_reason

Alasan surat mati, ketika pesan diterima dari subantrean deadletter entitas.

Mengembalikan

Jenis Deskripsi
str

dead_letter_source

Nama antrean atau langganan tempat pesan ini diantrekan, sebelum dihentikan. Properti ini hanya diatur dalam pesan yang telah di-dead-letter dan kemudian diteruskan secara otomatis dari antrean dead-letter ke entitas lain. Menunjukkan entitas di mana pesan tersebut sudah diberi dead-letter.

Mengembalikan

Jenis Deskripsi
str

delivery_count

Jumlah pengiriman yang telah dicoba untuk pesan ini. Jumlah bertambah ketika kunci pesan kedaluwarsa atau pesan secara eksplisit ditinggalkan oleh penerima.

Mengembalikan

Jenis Deskripsi
int

enqueued_sequence_number

Untuk pesan yang telah diteruskan secara otomatis, properti ini mencerminkan nomor urut yang pertama kali ditetapkan ke pesan pada titik awal pengirimannya.

Mengembalikan

Jenis Deskripsi
int

enqueued_time_utc

Tanggalwaktu UTC di mana pesan telah diterima dan disimpan dalam entitas.

Mengembalikan

Jenis Deskripsi
datetime

expires_at_utc

Tanggalwaktu UTC di mana pesan ditandai untuk dihapus dan tidak lagi tersedia untuk diambil dari entitas karena kedaluwarsa. Kedaluwarsa dikendalikan oleh properti Message.time_to_live . Properti ini dihitung dari Message.time_to_live Message.enqueued_time_utc + .

Mengembalikan

Jenis Deskripsi
datetime

lock_token

Token kunci untuk pesan saat ini berfungsi sebagai referensi ke kunci yang sedang ditahan oleh broker dalam mode PEEK_LOCK.

Mengembalikan

Jenis Deskripsi
UUID,
str

locked_until_utc

Tanggalwaktu UTC hingga pesan akan dikunci dalam antrean/langganan. Ketika kunci kedaluwarsa, jumlah pengiriman pesan bertambah dan pesan kembali tersedia untuk diambil.

Mengembalikan

Jenis Deskripsi
datetime

message

Dapatkan LegacyMessage yang mendasar. Ini tidak digunakan lagi dan akan dihapus dalam rilis selanjutnya.

Mengembalikan

Jenis Deskripsi
<xref:LegacyMessage>

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.

Mengembalikan

Jenis Deskripsi
str,
None

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.

Mengembalikan

Jenis Deskripsi
str,
None

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.

Mengembalikan

Jenis Deskripsi
str,
None

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.

Mengembalikan

Jenis Deskripsi
str,
None

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.

Mengembalikan

Jenis Deskripsi
datetime

sequence_number

Nomor unik yang ditetapkan ke pesan oleh Azure Service Bus. Nilai urut adalah bilangan bulat 64-bit unik yang ditetapkan untuk pesan karena diterima dan disimpan oleh broker dan fungsi sebagai pengidentifikasi internalnya. Untuk entitas yang dipartisi, 16 bit teratas mencerminkan pengidentifikasi partisi. Angka urutan meningkat secara monoton. Angka urutan bergulir ke 0 ketika kisaran 48-64 bit habis.

Mengembalikan

Jenis Deskripsi
int

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.

Mengembalikan

Jenis Deskripsi
str,
None

state

Default ke Aktif. Mewakili status pesan pesan. Bisa Aktif, Ditangguhkan. atau Terjadwal.

Mengembalikan

Jenis Deskripsi
ServiceBusMessageState

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.

Mengembalikan

Jenis Deskripsi
str

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

Mengembalikan

Jenis Deskripsi
timedelta

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.

Mengembalikan

Jenis Deskripsi
str,
None