Share via

ServiceBusReceivedMessage interface

  • Referensi
Paket:
@azure/service-bus

Menjelaskan pesan yang diterima dari Azure Service Bus selama operasi intip sehingga tidak dapat diselesaikan.

Extends
ServiceBusMessage

Properti

deadLetterErrorDescription

Deskripsi kesalahan untuk mematikan pesan.
deadLetterReason

Alasan untuk mematikan pesan.
deadLetterSource

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

Jumlah pengiriman yang telah dicoba untuk pesan ini. Jumlah bertambah saat kunci pesan kedaluwarsa, atau pesan secara eksplisit ditinggalkan menggunakan abandon() metode pada pesan.
enqueuedSequenceNumber

Nomor urutan asli pesan. Untuk pesan yang telah diteruskan secara otomatis, properti ini mencerminkan nomor urut yang pertama kali ditetapkan ke pesan pada titik pengiriman aslinya.
enqueuedTimeUtc

Instan UTC di mana pesan telah diterima dan disimpan di Azure Service Bus.
expiresAtUtc

Instan UTC di mana pesan ditandai untuk dihapus dan tidak lagi tersedia untuk diambil dari entitas karena kedaluwarsa. Properti ini dihitung dari 2 properti lain pada pesan: enqueuedTimeUtc + timeToLive.
lockedUntilUtc

Instan UTC hingga pesan disimpan terkunci dalam antrean/langganan. Ketika kunci kedaluwarsa, deliveryCount akan dinaikkan dan pesan kembali tersedia untuk diambil.

  • Tidak berlaku ketika pesan diterima dalam receiveAndDelete mode terima. Mode.
lockToken

Token kunci adalah referensi ke kunci yang sedang ditahan oleh broker dalam peekLock mode terima. Kunci digunakan untuk menyelesaikan pesan secara internal seperti yang dijelaskan dalam dokumentasi produk secara lebih rinci

  • Tidak berlaku ketika pesan diterima dalam receiveAndDelete mode terima. Mode.
sequenceNumber

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.

Bilangan bulat aman maks yang saat ini didukung Javascript adalah 2^53 - 1. Nomor urut adalah jenis AMQP Long yang panjangnya bisa hingga 64 bit. Untuk mewakili bahwa kita menggunakan pustaka bernama long.js. Kami mengharapkan pelanggan untuk menggunakan jenis yang diekspor Long oleh pustaka ini.
state

Status pesan dapat aktif, ditangguhkan, atau dijadwalkan. Pesan yang ditangguhkan memiliki status ditangguhkan, pesan terjadwal memiliki status terjadwal, semua pesan lain memiliki status aktif.

Properti yang Diwariskan

applicationProperties

Properti khusus aplikasi yang dapat digunakan untuk metadata pesan kustom.
body

Isi pesan yang perlu dikirim atau diterima. Jika aplikasi yang menerima pesan tidak menggunakan SDK ini, konversikan payload isi Anda ke array byte atau Buffer untuk kompatibilitas lintas bahasa yang lebih baik.
contentType

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

Pengidentifikasi korelasi yang memungkinkan aplikasi menentukan konteks untuk pesan untuk tujuan korelasi, misalnya mencerminkan MessageId pesan yang sedang dijawab. Lihat Perutean dan Korelasi Pesan.
messageId

Pengidentifikasi pesan adalah nilai yang ditentukan aplikasi yang secara unik mengidentifikasi pesan dan muatannya.

Catatan: Angka yang bukan bilangan bulat utuh tidak diizinkan.
partitionKey

Kunci partisi untuk mengirim pesan ke entitas yang dipartisi. Panjang maksimum adalah 128 karakter. Untuk entitas yang dipartisi, pengaturan nilai ini memungkinkan penetapan pesan terkait ke partisi internal yang sama, sehingga urutan pengiriman dicatat dengan benar. Partisi dipilih oleh fungsi hash atas nilai ini dan tidak dapat dipilih secara langsung.

  • Untuk entitas yang sadar sesi, sessionId properti mengambil alih nilai ini.
  • Untuk entitas yang tidak dipartisi, kunci partisi akan diabaikan
replyTo

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

Pengidentifikasi sesi yang menambah replyTo alamat. Panjang maksimum adalah 128 karakter. Nilai ini menambah informasi ReplyTo dan menentukan SessionId mana yang harus ditetapkan untuk balasan saat dikirim ke entitas balasan. Lihat Perutean dan Korelasi Pesan.
scheduledEnqueueTimeUtc

Tanggal dan waktu dalam UTC di mana pesan akan diantrekan. Properti ini mengembalikan waktu dalam UTC; saat mengatur properti, nilai DateTime yang disediakan juga harus dalam UTC. Nilai ini untuk pengiriman pesan tertunda. Ini digunakan untuk menunda pengiriman pesan ke waktu tertentu di masa mendatang. Waktu antrean pesan tidak berarti bahwa pesan akan dikirim secara bersamaan. Ini akan diantrekan, tetapi waktu pengiriman aktual tergantung pada beban kerja antrean dan statusnya.
sessionId

Pengidentifikasi sesi untuk entitas yang sadar sesi. Panjang maksimum adalah 128 karakter. Untuk entitas yang mengetahui 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 sadar sesi, nilai ini diabaikan. Sesi Pesan.
subject

Label spesifik aplikasi. Properti ini memungkinkan aplikasi untuk menunjukkan tujuan pesan kepada penerima dalam standar. mode, mirip dengan baris subjek email. Properti AMQP yang dipetakan adalah "subjek".
timeToLive

Waktu pesan untuk nilai hidup. Nilai ini adalah durasi relatif setelah pesan kedaluwarsa, mulai dari instan pesan telah diterima dan disimpan oleh broker, seperti yang diambil dalam enqueuedTimeUtc. Ketika tidak diatur secara eksplisit, nilai yang diasumsikan adalah DefaultTimeToLive untuk masing-masing antrean atau topik. Nilai tingkat timeToLive pesan tidak boleh lebih panjang dari pengaturan DefaultTimeToLive entitas dan diam-diam disesuaikan jika ya. Lihat Kedaluwarsa.
to

Alamat "ke". Properti ini dicadangkan 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.

Detail Properti

deadLetterErrorDescription

Deskripsi kesalahan untuk mematikan pesan.

deadLetterErrorDescription?: string

Nilai Properti

string

deadLetterReason

Alasan untuk mematikan pesan.

deadLetterReason?: string

Nilai Properti

string

deadLetterSource

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

deadLetterSource?: string

Nilai Properti

string

deliveryCount

Jumlah pengiriman yang telah dicoba untuk pesan ini. Jumlah bertambah saat kunci pesan kedaluwarsa, atau pesan secara eksplisit ditinggalkan menggunakan abandon() metode pada pesan.

deliveryCount?: number

Nilai Properti

number

enqueuedSequenceNumber

Nomor urutan asli pesan. Untuk pesan yang telah diteruskan secara otomatis, properti ini mencerminkan nomor urut yang pertama kali ditetapkan ke pesan pada titik pengiriman aslinya.

enqueuedSequenceNumber?: number

Nilai Properti

number

enqueuedTimeUtc

Instan UTC di mana pesan telah diterima dan disimpan di Azure Service Bus.

enqueuedTimeUtc?: Date

Nilai Properti

Date

expiresAtUtc

Instan UTC di mana pesan ditandai untuk dihapus dan tidak lagi tersedia untuk diambil dari entitas karena kedaluwarsa. Properti ini dihitung dari 2 properti lain pada pesan: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Nilai Properti

Date

lockedUntilUtc

Instan UTC hingga pesan disimpan terkunci dalam antrean/langganan. Ketika kunci kedaluwarsa, deliveryCount akan dinaikkan dan pesan kembali tersedia untuk diambil.

  • Tidak berlaku ketika pesan diterima dalam receiveAndDelete mode terima. Mode.
lockedUntilUtc?: Date

Nilai Properti

Date

lockToken

Token kunci adalah referensi ke kunci yang sedang ditahan oleh broker dalam peekLock mode terima. Kunci digunakan untuk menyelesaikan pesan secara internal seperti yang dijelaskan dalam dokumentasi produk secara lebih rinci

  • Tidak berlaku ketika pesan diterima dalam receiveAndDelete mode terima. Mode.
lockToken?: string

Nilai Properti

string

sequenceNumber

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.

Bilangan bulat aman maks yang saat ini didukung Javascript adalah 2^53 - 1. Nomor urut adalah jenis AMQP Long yang panjangnya bisa hingga 64 bit. Untuk mewakili bahwa kita menggunakan pustaka bernama long.js. Kami mengharapkan pelanggan untuk menggunakan jenis yang diekspor Long oleh pustaka ini.

sequenceNumber?: Long

Nilai Properti

Long

state

Status pesan dapat aktif, ditangguhkan, atau dijadwalkan. Pesan yang ditangguhkan memiliki status ditangguhkan, pesan terjadwal memiliki status terjadwal, semua pesan lain memiliki status aktif.

state: "active" | "deferred" | "scheduled"

Nilai Properti

"active" | "deferred" | "scheduled"

Detail Properti yang Diwariskan

applicationProperties

Properti khusus aplikasi yang dapat digunakan untuk metadata pesan kustom.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

Nilai Properti

{[key: string]: number | boolean | string | Date | null}

Diwarisi DariServiceBusMessage.applicationProperties

body

Isi pesan yang perlu dikirim atau diterima. Jika aplikasi yang menerima pesan tidak menggunakan SDK ini, konversikan payload isi Anda ke array byte atau Buffer untuk kompatibilitas lintas bahasa yang lebih baik.

body: any

Nilai Properti

any

Diwarisi DariServiceBusMessage.body

contentType

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

contentType?: string

Nilai Properti

string

Diwarisi DariServiceBusMessage.contentType

correlationId

Pengidentifikasi korelasi yang memungkinkan aplikasi menentukan konteks untuk pesan untuk tujuan korelasi, misalnya mencerminkan MessageId pesan yang sedang dijawab. Lihat Perutean dan Korelasi Pesan.

correlationId?: string | number | Buffer

Nilai Properti

string | number | Buffer

Diwarisi DariServiceBusMessage.correlationId

messageId

Pengidentifikasi pesan adalah nilai yang ditentukan aplikasi yang secara unik mengidentifikasi pesan dan muatannya.

Catatan: Angka yang bukan bilangan bulat utuh tidak diizinkan.

messageId?: string | number | Buffer

Nilai Properti

string | number | Buffer

Diwarisi DariServiceBusMessage.messageId

partitionKey

Kunci partisi untuk mengirim pesan ke entitas yang dipartisi. Panjang maksimum adalah 128 karakter. Untuk entitas yang dipartisi, pengaturan nilai ini memungkinkan penetapan pesan terkait ke partisi internal yang sama, sehingga urutan pengiriman dicatat dengan benar. Partisi dipilih oleh fungsi hash atas nilai ini dan tidak dapat dipilih secara langsung.

  • Untuk entitas yang sadar sesi, sessionId properti mengambil alih nilai ini.
  • Untuk entitas yang tidak dipartisi, kunci partisi akan diabaikan
partitionKey?: string

Nilai Properti

string

Diwarisi DariServiceBusMessage.partitionKey

replyTo

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.

replyTo?: string

Nilai Properti

string

Diwarisi DariServiceBusMessage.replyTo

replyToSessionId

Pengidentifikasi sesi yang menambah replyTo alamat. Panjang maksimum adalah 128 karakter. Nilai ini menambah informasi ReplyTo dan menentukan SessionId mana yang harus ditetapkan untuk balasan saat dikirim ke entitas balasan. Lihat Perutean dan Korelasi Pesan.

replyToSessionId?: string

Nilai Properti

string

Diwarisi DariServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Tanggal dan waktu dalam UTC di mana pesan akan diantrekan. Properti ini mengembalikan waktu dalam UTC; saat mengatur properti, nilai DateTime yang disediakan juga harus dalam UTC. Nilai ini untuk pengiriman pesan tertunda. Ini digunakan untuk menunda pengiriman pesan ke waktu tertentu di masa mendatang. Waktu antrean pesan tidak berarti bahwa pesan akan dikirim secara bersamaan. Ini akan diantrekan, tetapi waktu pengiriman aktual tergantung pada beban kerja antrean dan statusnya.

scheduledEnqueueTimeUtc?: Date

Nilai Properti

Date

Diwarisi DariServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

Pengidentifikasi sesi untuk entitas yang sadar sesi. Panjang maksimum adalah 128 karakter. Untuk entitas yang mengetahui 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 sadar sesi, nilai ini diabaikan. Sesi Pesan.

sessionId?: string

Nilai Properti

string

Diwarisi DariServiceBusMessage.sessionId

subject

Label spesifik aplikasi. Properti ini memungkinkan aplikasi untuk menunjukkan tujuan pesan kepada penerima dalam standar. mode, mirip dengan baris subjek email. Properti AMQP yang dipetakan adalah "subjek".

subject?: string

Nilai Properti

string

Diwarisi DariServiceBusMessage.subject

timeToLive

Waktu pesan untuk nilai hidup. Nilai ini adalah durasi relatif setelah pesan kedaluwarsa, mulai dari instan pesan telah diterima dan disimpan oleh broker, seperti yang diambil dalam enqueuedTimeUtc. Ketika tidak diatur secara eksplisit, nilai yang diasumsikan adalah DefaultTimeToLive untuk masing-masing antrean atau topik. Nilai tingkat timeToLive pesan tidak boleh lebih panjang dari pengaturan DefaultTimeToLive entitas dan diam-diam disesuaikan jika ya. Lihat Kedaluwarsa.

timeToLive?: number

Nilai Properti

number

Diwarisi DariServiceBusMessage.timeToLive

to

Alamat "ke". Properti ini dicadangkan 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.

to?: string

Nilai Properti

string

Diwarisi DariServiceBusMessage.to