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

QueueReceiveMessageOptions interface

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

Параметры настройки операции полученияMessages

Extends

MessagesDequeueOptionalParams,CommonOptions

Свойства

abortSignal

Реализация интерфейса AbortSignalLike для сигнала о запросе на отмену операции. Например, используйте контроллер @azure/abort-controller для создания AbortSignal.

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

numberOfMessages

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

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

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

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

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

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

abortSignal

Реализация интерфейса AbortSignalLike для сигнала о запросе на отмену операции. Например, используйте контроллер @azure/abort-controller для создания AbortSignal.

abortSignal?: AbortSignalLike

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

AbortSignalLike

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

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