QueueReceiveMessageOptions interface
Параметры для настройки операции receiveMessages
- Extends
Унаследованные свойства
abort |
Сигнал контроллера прерывания. Может использоваться для прерывания отправки сетевого запроса и ожидания ответа. |
custom |
будет применен до отправки запроса. |
number |
Необязательный элемент. Ненулевое целочисленное значение, которое определяет количество сообщений для получения из очереди (не более 32). Если видимых сообщений меньше, то возвращаются только видимые. По умолчанию эта операция возвращает одно сообщение из очереди. |
on |
Обратный вызов, который срабатывает при скачивании. |
on |
Обратный вызов, который срабатывает при выполнении отправки. |
request |
Клиент создал непрозрачное значение с ограничением символов, равным 1 КБ, которое записывается в журналы аналитики, когда ведение журнала службы аналитики хранилища включено. |
serializer |
Параметры для переопределения поведения синтаксического анализа и построения XML. |
should |
Следует ли десериализовать httpOperationResponse. Если этот параметр не определен, следует десериализовать httpOperationResponse. |
timeout | Количество миллисекундах, которые может занять запрос до автоматического завершения.
Если запрос завершается, |
timeout |
Параметр Время ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы очередей. |
tracing |
Трассировка: контекст, используемый при создании диапазонов. |
tracing |
Параметры для настройки диапазонов, созданных при включенной трассировке. |
visibility |
Необязательный элемент. Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Значение по умолчанию - 30 секунды. Указанное значение должно быть больше или равно 1 секунде и не может превышать 7 дней или больше 2 часов в версиях протокола REST до версии 2011-08-18. Время ожидания видимости сообщения может быть задано позже истечения срока. |
Сведения об унаследованном свойстве
abortSignal
Сигнал контроллера прерывания. Может использоваться для прерывания отправки сетевого запроса и ожидания ответа.
abortSignal?: AbortSignalLike
Значение свойства
Наследуется отMessagesDequeueOptionalParams.abortSignal
customHeaders
будет применен до отправки запроса.
customHeaders?: {[key: string]: string}
Значение свойства
{[key: string]: string}
Наследуется отMessagesDequeueOptionalParams.customHeaders
numberOfMessages
Необязательный элемент. Ненулевое целочисленное значение, которое определяет количество сообщений для получения из очереди (не более 32). Если видимых сообщений меньше, то возвращаются только видимые. По умолчанию эта операция возвращает одно сообщение из очереди.
numberOfMessages?: number
Значение свойства
number
Наследуется отMessagesDequeueOptionalParams.numberOfMessages
onDownloadProgress
Обратный вызов, который срабатывает при скачивании.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Значение свойства
(progress: TransferProgressEvent) => void
Наследуется отMessagesDequeueOptionalParams.onDownloadProgress
onUploadProgress
Обратный вызов, который срабатывает при выполнении отправки.
onUploadProgress?: (progress: TransferProgressEvent) => void
Значение свойства
(progress: TransferProgressEvent) => void
Наследуется отMessagesDequeueOptionalParams.onUploadProgress
requestId
Клиент создал непрозрачное значение с ограничением символов, равным 1 КБ, которое записывается в журналы аналитики, когда ведение журнала службы аналитики хранилища включено.
requestId?: string
Значение свойства
string
Наследуется отMessagesDequeueOptionalParams.requestId
serializerOptions
Параметры для переопределения поведения синтаксического анализа и построения XML.
serializerOptions?: SerializerOptions
Значение свойства
Наследуется отMessagesDequeueOptionalParams.serializerOptions
shouldDeserialize
Следует ли десериализовать httpOperationResponse. Если этот параметр не определен, следует десериализовать httpOperationResponse.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean
Значение свойства
boolean | (response: HttpOperationResponse) => boolean
Наследуется отMessagesDequeueOptionalParams.shouldDeserialize
timeout
Количество миллисекундах, которые может занять запрос до автоматического завершения.
Если запрос завершается, AbortError
возникает исключение .
timeout?: number
Значение свойства
number
Наследуется отMessagesDequeueOptionalParams.timeout
timeoutInSeconds
Параметр Время ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы очередей.
timeoutInSeconds?: number
Значение свойства
number
Наследуется отMessagesDequeueOptionalParams.timeoutInSeconds
tracingContext
Трассировка: контекст, используемый при создании диапазонов.
tracingContext?: Context
Значение свойства
Наследуется отMessagesDequeueOptionalParams.tracingContext
tracingOptions
Параметры для настройки диапазонов, созданных при включенной трассировке.
tracingOptions?: OperationTracingOptions
Значение свойства
Наследуется отCommonOptions.tracingOptions
visibilityTimeout
Необязательный элемент. Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Значение по умолчанию - 30 секунды. Указанное значение должно быть больше или равно 1 секунде и не может превышать 7 дней или больше 2 часов в версиях протокола REST до версии 2011-08-18. Время ожидания видимости сообщения может быть задано позже истечения срока.
visibilityTimeout?: number
Значение свойства
number
Наследуется отMessagesDequeueOptionalParams.visibilityTimeout