QueueReceiveMessageOptions interface

Paket:

@azure/storage-queue

Alternativ för att konfigurera åtgärden receiveMessages

Extends

MessagesDequeueOptionalParams,CommonOptions

Ärvda egenskaper

abortSignal	Signal för en avbruten styrenhet. Kan användas för att avbryta både skicka en nätverksbegäran och vänta på ett svar.
customHeaders	tillämpas innan begäran skickas.
numberOfMessages	Valfritt. Ett heltalsvärde som inte är noll och som anger hur många meddelanden som ska hämtas från kön, upp till högst 32. Om färre visas returneras de synliga meddelandena. Som standard hämtas ett enda meddelande från kön med den här åtgärden.
onDownloadProgress	Återanrop som utlöses vid nedladdningsframställning.
onUploadProgress	Återanrop som utlöses vid uppladdningsstatus.
requestId	Ger ett klientgenererat, täckande värde med en teckengräns på 1 KB som registreras i analysloggarna när loggning av lagringsanalys är aktiverat.
serializerOptions	Alternativ för att åsidosätta XML-parsning/byggnadsbeteende.
shouldDeserialize	Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.
timeout	Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt. Om begäran avslutas utlöses en AbortError .
timeoutInSeconds	Timeout-parametern uttrycks i sekunder. Mer information finns i Ställa in tidsgränser för kötjänståtgärder.
tracingContext	Spårning: Kontext som används när du skapar intervall.
tracingOptions	Alternativ för att konfigurera intervall som skapas när spårning är aktiverat.
visibilityTimeout	Valfritt. Anger det nya tidsgränsvärdet för synlighet, i sekunder, i förhållande till servertiden. Standardvärdet är 30 sekunder. Ett angivet värde måste vara större än eller lika med 1 sekund och får inte vara större än 7 dagar eller större än 2 timmar i REST-protokollversioner före version 2011-08-18. Tidsgränsen för ett meddelandes synlighet kan anges till ett värde senare än förfallotiden.

Information om ärvda egenskaper

abortSignal

Signal för en avbruten styrenhet. Kan användas för att avbryta både skicka en nätverksbegäran och vänta på ett svar.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

Ärvd frånMessagesDequeueOptionalParams.abortSignal

customHeaders

tillämpas innan begäran skickas.

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

Egenskapsvärde

{[key: string]: string}

Ärvd frånMessagesDequeueOptionalParams.customHeaders

numberOfMessages

Valfritt. Ett heltalsvärde som inte är noll och som anger hur många meddelanden som ska hämtas från kön, upp till högst 32. Om färre visas returneras de synliga meddelandena. Som standard hämtas ett enda meddelande från kön med den här åtgärden.

numberOfMessages?: number

Egenskapsvärde

number

Ärvd frånMessagesDequeueOptionalParams.numberOfMessages

onDownloadProgress

Återanrop som utlöses vid nedladdningsframställning.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

Ärvd frånMessagesDequeueOptionalParams.onDownloadProgress

onUploadProgress

Återanrop som utlöses vid uppladdningsstatus.

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

Ärvd frånMessagesDequeueOptionalParams.onUploadProgress

requestId

Ger ett klientgenererat, täckande värde med en teckengräns på 1 KB som registreras i analysloggarna när loggning av lagringsanalys är aktiverat.

requestId?: string

Egenskapsvärde

string

Ärvt frånMessagesDequeueOptionalParams.requestId

serializerOptions

Alternativ för att åsidosätta XML-parsning/byggnadsbeteende.

serializerOptions?: SerializerOptions

Egenskapsvärde

SerializerOptions

Ärvd frånMessagesDequeueOptionalParams.serializerOptions

shouldDeserialize

Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.

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

Egenskapsvärde

boolean | (response: HttpOperationResponse) => boolean

Ärvd frånMessagesDequeueOptionalParams.shouldDeserialize

timeout

Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt. Om begäran avslutas utlöses en AbortError .

timeout?: number

Egenskapsvärde

number

Ärvd frånMessagesDequeueOptionalParams.timeout

timeoutInSeconds

Timeout-parametern uttrycks i sekunder. Mer information finns i Ställa in tidsgränser för kötjänståtgärder.

timeoutInSeconds?: number

Egenskapsvärde

number

Ärvd frånMessagesDequeueOptionalParams.timeoutInSeconds

tracingContext

Spårning: Kontext som används när du skapar intervall.

tracingContext?: Context

Egenskapsvärde

@azure/core-tracing.Context

Ärvd frånMessagesDequeueOptionalParams.tracingContext

tracingOptions

Alternativ för att konfigurera intervall som skapas när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

Ärvd frånCommonOptions.tracingOptions

visibilityTimeout

Valfritt. Anger det nya tidsgränsvärdet för synlighet, i sekunder, i förhållande till servertiden. Standardvärdet är 30 sekunder. Ett angivet värde måste vara större än eller lika med 1 sekund och får inte vara större än 7 dagar eller större än 2 timmar i REST-protokollversioner före version 2011-08-18. Tidsgränsen för ett meddelandes synlighet kan anges till ett värde senare än förfallotiden.

visibilityTimeout?: number

Egenskapsvärde

number

Ärvd frånMessagesDequeueOptionalParams.visibilityTimeout