Bagikan melalui

MessagesDequeueOptionalParams interface

Paket:
@azure/storage-queue

Parameter opsional.

Memperluas

RequestOptionsBase

Properti

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.
customHeaders

akan diterapkan sebelum permintaan dikirim.
numberOfMessages

Fakultatif. Nilai bilangan bulat bukan nol yang menentukan jumlah pesan yang akan diambil dari antrean, hingga maksimum 32. Jika lebih sedikit yang terlihat, pesan yang terlihat akan dikembalikan. Secara default, satu pesan diambil dari antrean dengan operasi ini.
onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.
onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.
requestId

Menyediakan nilai buram yang dihasilkan klien dengan batas karakter 1 KB yang dicatat dalam log analitik saat pengelogan analitik penyimpanan diaktifkan.
serializerOptions

Opsi untuk mengambil alih perilaku penguraian/bangunan XML.
shouldDeserialize

Apakah HttpOperationResponse harus dideserialisasi atau tidak. Jika ini tidak terdefinisi, maka HttpOperationResponse harus dideserialisasi.
timeout

Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis. Jika permintaan dihentikan, AbortError akan dilemparkan.
timeoutInSeconds

Parameter batas waktu dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur Batas Waktu untuk Operasi Layanan Antrean.
tracingContext

Pelacakan: Konteks yang digunakan saat membuat rentang.
visibilityTimeout

Fakultatif. Menentukan nilai batas waktu visibilitas baru, dalam detik, relatif terhadap waktu server. Nilai defaultnya adalah 30 detik. Nilai yang ditentukan harus lebih besar dari atau sama dengan 1 detik, dan tidak boleh lebih besar dari 7 hari, atau lebih besar dari 2 jam pada versi protokol REST sebelum versi 2011-08-18. Batas waktu visibilitas pesan dapat diatur ke nilai lebih lambat dari waktu kedaluwarsa.

Detail Properti

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

customHeaders

akan diterapkan sebelum permintaan dikirim.

customHeaders?: [key: string]: string

Nilai Properti

[key: string]: string

numberOfMessages

Fakultatif. Nilai bilangan bulat bukan nol yang menentukan jumlah pesan yang akan diambil dari antrean, hingga maksimum 32. Jika lebih sedikit yang terlihat, pesan yang terlihat akan dikembalikan. Secara default, satu pesan diambil dari antrean dengan operasi ini.

numberOfMessages?: number

Nilai Properti

number

onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.

onUploadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

requestId

Menyediakan nilai buram yang dihasilkan klien dengan batas karakter 1 KB yang dicatat dalam log analitik saat pengelogan analitik penyimpanan diaktifkan.

requestId?: string

Nilai Properti

string

serializerOptions

Opsi untuk mengambil alih perilaku penguraian/bangunan XML.

serializerOptions?: SerializerOptions

Nilai Properti

SerializerOptions

shouldDeserialize

Apakah HttpOperationResponse harus dideserialisasi atau tidak. Jika ini tidak terdefinisi, maka HttpOperationResponse harus dideserialisasi.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Nilai Properti

boolean | (response: HttpOperationResponse) => boolean

timeout

Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis. Jika permintaan dihentikan, AbortError akan dilemparkan.

timeout?: number

Nilai Properti

number

timeoutInSeconds

Parameter batas waktu dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur Batas Waktu untuk Operasi Layanan Antrean.

timeoutInSeconds?: number

Nilai Properti

number

tracingContext

Pelacakan: Konteks yang digunakan saat membuat rentang.

tracingContext?: Context

Nilai Properti

Context

visibilityTimeout

Fakultatif. Menentukan nilai batas waktu visibilitas baru, dalam detik, relatif terhadap waktu server. Nilai defaultnya adalah 30 detik. Nilai yang ditentukan harus lebih besar dari atau sama dengan 1 detik, dan tidak boleh lebih besar dari 7 hari, atau lebih besar dari 2 jam pada versi protokol REST sebelum versi 2011-08-18. Batas waktu visibilitas pesan dapat diatur ke nilai lebih lambat dari waktu kedaluwarsa.

visibilityTimeout?: number

Nilai Properti

number