Поделиться через

QueueReceiveMessageOptions interface

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

Параметры для настройки операции receiveMessages

Extends

MessagesDequeueOptionalParams,CommonOptions

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

numberOfMessages

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

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

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

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

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

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

numberOfMessages

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

numberOfMessages?: number

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

number

Наследуется отMessagesDequeueOptionalParams.numberOfMessages

requestId

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

requestId?: string

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

string

Наследуется отMessagesDequeueOptionalParams.requestId

timeoutInSeconds

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

timeoutInSeconds?: number

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

number

Наследуется отMessagesDequeueOptionalParams.timeoutInSeconds

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

OperationTracingOptions

Наследуется отCommonOptions.tracingOptions

visibilityTimeout

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

visibilityTimeout?: number

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

number

Наследуется отmessagesDequeueOptionalParams.visibilityTimeout