Share via

MessagesDequeueOptionalParams interface

  • Ссылка
Пакет:
@azure/storage-queue

Дополнительные параметры.

Extends
RequestOptionsBase

Свойства

numberOfMessages

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

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

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

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

Унаследованные свойства

abortSignal

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

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

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

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

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

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

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

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

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

numberOfMessages

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

numberOfMessages?: number

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

number

requestId

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

requestId?: string

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

string

timeoutInSeconds

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

timeoutInSeconds?: number

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

number

visibilityTimeout

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

visibilityTimeout?: number

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

number

Сведения об унаследованном свойстве

abortSignal

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

abortSignal?: AbortSignalLike

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

AbortSignalLike

Наследуется от RequestOptionsBase.abortSignal

customHeaders

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

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

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

{[key: string]: string}

Наследуется от RequestOptionsBase.customHeaders

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

Наследуется от RequestOptionsBase.onDownloadProgress

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

Наследуется от RequestOptionsBase.onUploadProgress

serializerOptions

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

serializerOptions?: SerializerOptions

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

SerializerOptions

Наследуется от RequestOptionsBase.serializerOptions

shouldDeserialize

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

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

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

boolean | (response: HttpOperationResponse) => boolean

Наследуется от RequestOptionsBase.shouldDeserialize

timeout

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

timeout?: number

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

number

Наследуется от RequestOptionsBase.timeout

tracingContext

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

tracingContext?: Context

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

@azure/core-tracing.Context

Наследуется от RequestOptionsBase.tracingContext