@azure/core-lro package
Lro |
Модуль LRO— класс, выполняющий опрос. |
Poller |
Класс , представляющий определение программы, которая опрашивает через последовательные запросы, пока не достигнет состояния завершения. Средство опроса можно выполнить вручную, опрашив запрос по запросу путем многократного
Poller определяется двумя типами: типом, представляющим состояние опрашивающего объекта, который должен включать базовый набор свойств из Класс Poller реализует
Опрашиватель можно создать с помощью его конструктора, а затем его можно опрашивировать до завершения. В любой момент времени состояние объекта опроса можно получить без задержки с помощью метода getOperationState. В любой момент времени промежуточные формы типа результата можно запрашивать без задержки. После того как базовая операция будет помечена как завершенная, средство опроса остановится и будет возвращено окончательное значение.
|
Poller |
При отмене операции средство опроса будет отклонено с экземпляром PollerCancelledError. |
Poller |
Когда средство опроса останавливается вручную с помощью |
Create |
Параметры для |
Long |
Описание длительной операции. |
Lro |
Параметры для средства опроса LRO. |
Lro |
Тип ответа LRO. |
Operation |
В то время как средство опроса работает как локальный механизм управления для запуска и ожидания длительной операции, OperationState документирует состояние удаленной длительной операции. Он обновляется после каждого опроса. |
Poll |
PollOperation — это интерфейс, который определяет, как обновлять локальную ссылку на состояние удаленной длительно выполняющейся операции, а также как запрашивать отмену той же операции. Он также имеет метод сериализации операции, чтобы ее можно было сохранить и возобновить в любое время. |
Poll |
PollOperationState содержит список наименьшего набора свойств, необходимых для определения любого длительно выполняющегося опрашителя операций. Хотя класс Poller работает как локальный механизм управления для запуска, ожидания и, возможно, отмены длительной операции, PollOperationState документирует состояние удаленной длительно выполняющейся операции. Он должен обновляться по крайней мере при запуске операции, по завершении и при отмене операции. Однако реализации могут иметь любое другое количество свойств, которые могут быть обновлены по другим причинам. |
Poller |
Абстрактное представление опроса, предназначенное для предоставления только минимального API, с которым должен работать пользователь. |
Raw |
Простой тип необработанного ответа. |
Simple |
Простой интерфейс средства опроса. |
Cancel |
CancelOnProgress используется в качестве возвращаемого значения метода onProgress poller. Когда пользователь вызывает onProgress, он должен передать функцию, которая будет вызываться в качестве обратного вызова с новыми данными, получаемыми при каждом обновлении операции опроса. onProgress возвращает функцию, которая не позволяет при дальнейшем обновлении достичь исходного обратного вызова. |
Lro |
Потенциальное расположение результата LRO, если указано расширением LRO в swagger. |
Operation |
Набор возможных состояний, в которые может находиться операция в любой момент времени. |
Poll |
PollProgressCallback — это тип функций обратного вызова, отправляемых в onProgress. Эти функции получат TState, определенный реализацией класса Poller. |
create |
Создает средство опроса, которое можно использовать для опроса длительной операции. |
createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Создает средство опроса, которое можно использовать для опроса длительной операции.
function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>
Параметры
- lro
-
LongRunningOperation<unknown>
Описание длительной операции
- options
-
CreateHttpPollerOptions<TResult, TState>
параметры для настройки средства опроса
Возвращаемое значение
Promise<SimplePollerLike<TState, TResult>>
инициализированное средство опроса