QueueReceiveMessageOptions interface

Paket:

@azure/storage-queue

receiveMessages işlemini yapılandırma seçenekleri

Extends

MessagesDequeueOptionalParams,CommonOptions

Devralınan Özellikler

abortSignal	İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.
customHeaders	istek gönderilmeden önce uygulanır.
numberOfMessages	İsteğe bağlı. Kuyruktan alınacak ileti sayısını en fazla 32 olarak belirten sıfır olmayan bir tamsayı değeri. Daha az görünürse, görünür iletiler döndürülür. Varsayılan olarak, bu işlemle kuyruktan tek bir ileti alınır.
onDownloadProgress	İndirme ilerlemesi üzerine tetiklenen geri çağırma.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.
requestId	Depolama analizi günlüğü etkinleştirildiğinde analiz günlüklerine kaydedilen 1 KB karakter sınırına sahip istemci tarafından oluşturulan, opak bir değer sağlar.
serializerOptions	XML ayrıştırma/oluşturma davranışını geçersiz kılma seçenekleri.
shouldDeserialize	HttpOperationResponse'un seri durumdan çıkarılıp çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.
timeout	bir isteğin otomatik olarak sonlandırılmadan önce alabildiği milisaniye sayısı. İstek sonlandırılırsa bir AbortError oluşturulur.
timeoutInSeconds	Zaman aşımı parametresi saniye cinsinden ifade edilir. Daha fazla bilgi için bkz. Kuyruk Hizmeti İşlemleri için Zaman Aşımlarını Ayarlama.
tracingContext	İzleme: Yayılma alanları oluşturulurken kullanılan bağlam.
tracingOptions	İzleme etkinleştirildiğinde oluşturulan span'ları yapılandırma seçenekleri.
visibilityTimeout	İsteğe bağlı. Sunucu süresine göre yeni görünürlük zaman aşımı değerini saniye olarak belirtir. Varsayılan değer 30 saniyedir. Belirtilen değer 1 saniyeden büyük veya buna eşit olmalıdır ve 7 günden büyük veya 2011-08-18 sürümünden önceki REST protokolü sürümlerinde 2 saatten büyük olamaz. İletinin görünürlük zaman aşımı süresi, süre sonu tarihinden sonraki bir değere ayarlanabilir.

Devralınan Özellik Detayları

abortSignal

İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

MessagesDequeueOptionalParams.abortSignal'danDevralındı

customHeaders

istek gönderilmeden önce uygulanır.

customHeaders?: {[key: string]: string}

Özellik Değeri

{[key: string]: string}

MessagesDequeueOptionalParams.customHeaders'danDevralındı

numberOfMessages

İsteğe bağlı. Kuyruktan alınacak ileti sayısını en fazla 32 olarak belirten sıfır olmayan bir tamsayı değeri. Daha az görünürse, görünür iletiler döndürülür. Varsayılan olarak, bu işlemle kuyruktan tek bir ileti alınır.

numberOfMessages?: number

Özellik Değeri

number

MessagesDequeueOptionalParams.numberOfMessages'danDevralındı

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri çağırma.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

MessagesDequeueOptionalParams.onDownloadProgress'tenDevralındı

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

MessagesDequeueOptionalParams.onUploadProgress'tenDevralındı

requestId

Depolama analizi günlüğü etkinleştirildiğinde analiz günlüklerine kaydedilen 1 KB karakter sınırına sahip istemci tarafından oluşturulan, opak bir değer sağlar.

requestId?: string

Özellik Değeri

string

MessagesDequeueOptionalParams.requestId'denDevralındı

serializerOptions

XML ayrıştırma/oluşturma davranışını geçersiz kılma seçenekleri.

serializerOptions?: SerializerOptions

Özellik Değeri

SerializerOptions

MessagesDequeueOptionalParams.serializerOptions'danDevralındı

shouldDeserialize

HttpOperationResponse'un seri durumdan çıkarılıp çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.

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

Özellik Değeri

boolean | (response: HttpOperationResponse) => boolean

MessagesDequeueOptionalParams.shouldDeserialize'danDevralındı

timeout

bir isteğin otomatik olarak sonlandırılmadan önce alabildiği milisaniye sayısı. İstek sonlandırılırsa bir AbortError oluşturulur.

timeout?: number

Özellik Değeri

number

MessagesDequeueOptionalParams.timeout'tanDevralındı

timeoutInSeconds

Zaman aşımı parametresi saniye cinsinden ifade edilir. Daha fazla bilgi için bkz. Kuyruk Hizmeti İşlemleri için Zaman Aşımlarını Ayarlama.

timeoutInSeconds?: number

Özellik Değeri

number

MessagesDequeueOptionalParams.timeoutInSecondsÖğesinden Devralındı

tracingContext

İzleme: Yayılma alanları oluşturulurken kullanılan bağlam.

tracingContext?: Context

Özellik Değeri

@azure/core-tracing.Context

MessagesDequeueOptionalParams.tracingContext'tenDevralındı

tracingOptions

İzleme etkinleştirildiğinde oluşturulan span'ları yapılandırma seçenekleri.

tracingOptions?: OperationTracingOptions

Özellik Değeri

OperationTracingOptions

CommonOptions.tracingOptions'danDevralındı

visibilityTimeout

İsteğe bağlı. Sunucu süresine göre yeni görünürlük zaman aşımı değerini saniye olarak belirtir. Varsayılan değer 30 saniyedir. Belirtilen değer 1 saniyeden büyük veya buna eşit olmalıdır ve 7 günden büyük veya 2011-08-18 sürümünden önceki REST protokolü sürümlerinde 2 saatten büyük olamaz. İletinin görünürlük zaman aşımı süresi, süre sonu tarihinden sonraki bir değere ayarlanabilir.

visibilityTimeout?: number

Özellik Değeri

number

MessagesDequeueOptionalParams.visibilityTimeout'tanDevralındı