QueueReceiveMessageOptions interface

Paket:

@azure/storage-queue

Optionen zum Konfigurieren des receiveMessages-Vorgangs

Extends

MessagesDequeueOptionalParams,CommonOptions

Geerbte Eigenschaften

abortSignal	Signal eines Abbruchcontrollers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.
customHeaders	wird angewendet, bevor die Anforderung gesendet wird.
numberOfMessages	Dies ist optional. Ein ganzzahliger Wert ungleich 0 (null), der die Anzahl der Nachrichten angibt, die aus der Warteschlange abgerufen werden sollen; der maximale Wert beträgt 32. Wenn weniger sichtbar sind, werden die sichtbaren Nachrichten zurückgegeben. Standardmäßig wird mit diesem Vorgang eine einzige Nachricht aus der Warteschlange abgerufen.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Uploadvorgang ausgelöst wird.
requestId	Stellt einen vom Client generierten, nicht transparenten Wert mit einer Zeichenbeschränkung von 1 KB bereit, der bei Aktivierung der Speicheranalyse-Protokollierung in den Analyseprotokollen erfasst wird.
serializerOptions	Optionen zum Überschreiben des XML-Analyse-/Erstellungsverhaltens.
shouldDeserialize	Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird eine AbortError ausgelöst.
timeoutInSeconds	Der Timeoutparameter wird in Sekunden ausgedrückt. Weitere Informationen finden Sie unter Festlegen von Timeouts für Warteschlangendienstvorgänge.
tracingContext	Ablaufverfolgung: Kontext, der beim Erstellen von Spans verwendet wird.
tracingOptions	Optionen zum Konfigurieren von Spans, die erstellt werden, wenn die Ablaufverfolgung aktiviert ist.
visibilityTimeout	Dies ist optional. Gibt den neuen Sichtbarkeitstimeoutwert in Sekunden relativ zur Serverzeit an. Der Standardwert ist 30 Sekunden. Ein angegebener Wert muss größer oder gleich 1 Sekunde sein und darf bei REST-Protokollversionen vor Version 2011-08-18 nicht größer als 7 Tage oder größer als 2 Stunden sein. Das Sichtbarkeitstimeout einer Nachricht kann auf einen Wert festgelegt werden, der nach der Ablaufzeit liegt.

Geerbte Eigenschaftsdetails

abortSignal

Signal eines Abbruchcontrollers. Kann verwendet werden, um sowohl das Senden einer Netzwerkanforderung als auch das Warten auf eine Antwort abzubrechen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt vonMessagesDequeueOptionalParams.abortSignal

customHeaders

wird angewendet, bevor die Anforderung gesendet wird.

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

Eigenschaftswert

{[key: string]: string}

Geerbt vonMessagesDequeueOptionalParams.customHeaders

numberOfMessages

Dies ist optional. Ein ganzzahliger Wert ungleich 0 (null), der die Anzahl der Nachrichten angibt, die aus der Warteschlange abgerufen werden sollen; der maximale Wert beträgt 32. Wenn weniger sichtbar sind, werden die sichtbaren Nachrichten zurückgegeben. Standardmäßig wird mit diesem Vorgang eine einzige Nachricht aus der Warteschlange abgerufen.

numberOfMessages?: number

Eigenschaftswert

number

Geerbt vonMessagesDequeueOptionalParams.numberOfMessages

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt vonMessagesDequeueOptionalParams.onDownloadProgress

onUploadProgress

Rückruf, der beim Uploadvorgang ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt vonMessagesDequeueOptionalParams.onUploadProgress

requestId

Stellt einen vom Client generierten, nicht transparenten Wert mit einer Zeichenbeschränkung von 1 KB bereit, der bei Aktivierung der Speicheranalyse-Protokollierung in den Analyseprotokollen erfasst wird.

requestId?: string

Eigenschaftswert

string

Geerbt vonMessagesDequeueOptionalParams.requestId

serializerOptions

Optionen zum Überschreiben des XML-Analyse-/Erstellungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

Geerbt vonMessagesDequeueOptionalParams.serializerOptions

shouldDeserialize

Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.

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

Eigenschaftswert

boolean | (response: HttpOperationResponse) => boolean

Geerbt vonMessagesDequeueOptionalParams.shouldDeserialize

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird. Wenn die Anforderung beendet wird, wird eine AbortError ausgelöst.

timeout?: number

Eigenschaftswert

number

Geerbt vonMessagesDequeueOptionalParams.timeout

timeoutInSeconds

Der Timeoutparameter wird in Sekunden ausgedrückt. Weitere Informationen finden Sie unter Festlegen von Timeouts für Warteschlangendienstvorgänge.

timeoutInSeconds?: number

Eigenschaftswert

number

Geerbt vonMessagesDequeueOptionalParams.timeoutInSeconds

tracingContext

Ablaufverfolgung: Kontext, der beim Erstellen von Spans verwendet wird.

tracingContext?: Context

Eigenschaftswert

@azure/core-tracing.Context

Geerbt vonMessagesDequeueOptionalParams.tracingContext

tracingOptions

Optionen zum Konfigurieren von Spans, die erstellt werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

Geerbt vonCommonOptions.tracingOptions

visibilityTimeout

Dies ist optional. Gibt den neuen Sichtbarkeitstimeoutwert in Sekunden relativ zur Serverzeit an. Der Standardwert ist 30 Sekunden. Ein angegebener Wert muss größer oder gleich 1 Sekunde sein und darf bei REST-Protokollversionen vor Version 2011-08-18 nicht größer als 7 Tage oder größer als 2 Stunden sein. Das Sichtbarkeitstimeout einer Nachricht kann auf einen Wert festgelegt werden, der nach der Ablaufzeit liegt.

visibilityTimeout?: number

Eigenschaftswert

number

Geerbt vonMessagesDequeueOptionalParams.visibilityTimeout