QueueReceiveMessageOptions interface

Пакет:

@azure/storage-queue

Параметры настройки операции <xref:QueueClient.receiveMessages>

Extends

MessagesDequeueOptionalParams

Свойства

abortSignal	Сигнал, который можно использовать для прерывания запросов.
customHeaders	будет применяться перед отправкой запроса.
numberOfMessages	Необязательный. Ненулевое целочисленное значение, указывающее количество сообщений, извлекаемых из очереди, не более 32. Если меньше видимых, возвращаются видимые сообщения. По умолчанию одно сообщение извлекается из очереди с этой операцией.
onDownloadProgress	Обратный вызов, который запускается при выполнении скачивания.
onUploadProgress	Обратный вызов, который запускается при выполнении отправки.
requestId	Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 КБ символов, которое записывается в журналы аналитики при включении ведения журнала аналитики хранилища.
serializerOptions	Параметры переопределения поведения синтаксического анализа и построения XML.
shouldDeserialize	Следует ли десериализировать httpOperationResponse. Если это не определено, необходимо десериализировать httpOperationResponse.
timeout	Число миллисекундах запроса может приниматься перед автоматическим завершением. Если запрос завершается, создается AbortError.
timeoutInSeconds	Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы очередей.
tracingContext	Трассировка: контекст, используемый при создании диапазонов.
tracingOptions	Параметры настройки диапазонов, созданных при включении трассировки.
visibilityTimeout	Необязательный. Задает новое значение времени ожидания видимости в секундах относительно времени сервера. Значение по умолчанию — 30 секунд. Указанное значение должно быть больше или равно 1 секунде и не может быть больше 7 дней или больше 2 часов в версиях протокола REST до версии 2011-08-18. Время ожидания видимости сообщения может быть задано в значение позже истечения срока действия.

Сведения о свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

customHeaders

будет применяться перед отправкой запроса.

customHeaders?: [key: string]: string

Значение свойства

[key: string]: string

numberOfMessages

Необязательный. Ненулевое целочисленное значение, указывающее количество сообщений, извлекаемых из очереди, не более 32. Если меньше видимых, возвращаются видимые сообщения. По умолчанию одно сообщение извлекается из очереди с этой операцией.

numberOfMessages?: number

Значение свойства

number

onDownloadProgress

Обратный вызов, который запускается при выполнении скачивания.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

onUploadProgress

Обратный вызов, который запускается при выполнении отправки.

onUploadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

requestId

Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 КБ символов, которое записывается в журналы аналитики при включении ведения журнала аналитики хранилища.

requestId?: string

Значение свойства

string

serializerOptions

Параметры переопределения поведения синтаксического анализа и построения XML.

serializerOptions?: SerializerOptions

Значение свойства

SerializerOptions

shouldDeserialize

Следует ли десериализировать httpOperationResponse. Если это не определено, необходимо десериализировать httpOperationResponse.

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

Значение свойства

boolean | (response: HttpOperationResponse) => boolean

timeout

Число миллисекундах запроса может приниматься перед автоматическим завершением. Если запрос завершается, создается AbortError.

timeout?: number

Значение свойства

number

timeoutInSeconds

Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы очередей.

timeoutInSeconds?: number

Значение свойства

number

tracingContext

Трассировка: контекст, используемый при создании диапазонов.

tracingContext?: Context

Значение свойства

Context

tracingOptions

Параметры настройки диапазонов, созданных при включении трассировки.

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

visibilityTimeout

Необязательный. Задает новое значение времени ожидания видимости в секундах относительно времени сервера. Значение по умолчанию — 30 секунд. Указанное значение должно быть больше или равно 1 секунде и не может быть больше 7 дней или больше 2 часов в версиях протокола REST до версии 2011-08-18. Время ожидания видимости сообщения может быть задано в значение позже истечения срока действия.

visibilityTimeout?: number

Значение свойства

number