SimplePollerLike interface

Пакет:

@azure-rest/arm-compute

Простой опросщик, который можно использовать для опроса длительной операции.

Методы

getOperationState()	Возвращает состояние операции.
getResult()	Возвращает значение результата операции независимо от состояния опроса. Он может возвращать неопределенную или неполную форму окончательного значения TResult в зависимости от реализации.
isDone()	Возвращает значение true, если опрашивание завершено.
isStopped()	Возвращает значение true, если опрашиватель остановлен.
onProgress((state: TState) => void)	Вызывает предоставленный обратный вызов после завершения каждого опроса, отправляя текущее состояние операции опроса. Он возвращает метод, который можно использовать для остановки получения обновлений для данной функции обратного вызова.
poll({ abortSignal?: AbortSignalLike })	Возвращает обещание, которое будет разрешаться после завершения одного запроса опроса. Это делается путем вызова метода обновления операции Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Возвращает обещание, которое будет разрешаться после завершения базовой операции.
serialize()	Возвращает обещание, которое можно использовать для сериализованной версии операции опроса путем вызова метода сериализации операции.
stopPolling()	Останавливает опросщик от продолжения опроса. Обратите внимание, что это приведет только к остановке опроса на стороне клиента
submitted()	Подождите отправку опрашителя.
toString()	Возвращает строковое представление операции опроса. Аналогично сериализации, но возвращает строку.

Сведения о методе

getOperationState()

Возвращает состояние операции.

function getOperationState(): TState

Возвращаемое значение

TState

getResult()

Возвращает значение результата операции независимо от состояния опроса. Он может возвращать неопределенную или неполную форму окончательного значения TResult в зависимости от реализации.

function getResult(): undefined | TResult

Возвращаемое значение

undefined | TResult

isDone()

Возвращает значение true, если опрашивание завершено.

function isDone(): boolean

Возвращаемое значение

boolean

isStopped()

Предупреждение

Теперь этот API является нерекомендуемым.

Use abortSignal status to track this instead.

Возвращает значение true, если опрашиватель остановлен.

function isStopped(): boolean

Возвращаемое значение

boolean

onProgress((state: TState) => void)

Вызывает предоставленный обратный вызов после завершения каждого опроса, отправляя текущее состояние операции опроса.

Он возвращает метод, который можно использовать для остановки получения обновлений для данной функции обратного вызова.

function onProgress(callback: (state: TState) => void): CancelOnProgress

Параметры

callback

(state: TState) => void

Возвращаемое значение

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Возвращает обещание, которое будет разрешаться после завершения одного запроса опроса. Это делается путем вызова метода обновления операции Poller.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>

Параметры

options

{ abortSignal?: AbortSignalLike }

Возвращаемое значение

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Возвращает обещание, которое будет разрешаться после завершения базовой операции.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

Параметры

pollOptions

{ abortSignal?: AbortSignalLike }

Возвращаемое значение

Promise<TResult>

serialize()

Возвращает обещание, которое можно использовать для сериализованной версии операции опроса путем вызова метода сериализации операции.

function serialize(): Promise<string>

Возвращаемое значение

Promise<string>

stopPolling()

Предупреждение

Теперь этот API является нерекомендуемым.

Use abortSignal to stop polling instead.

Останавливает опросщик от продолжения опроса. Обратите внимание, что это приведет только к остановке опроса на стороне клиента

function stopPolling()

submitted()

Подождите отправку опрашителя.

function submitted(): Promise<void>

Возвращаемое значение

Promise<void>

toString()

Предупреждение

Теперь этот API является нерекомендуемым.

Use serialize() instead.

Возвращает строковое представление операции опроса. Аналогично сериализации, но возвращает строку.

function toString(): string

Возвращаемое значение

string