SimplePollerLike interface

Pacote:

@azure/arm-elasticsan

Um poller simples que pode ser usado para sondar uma operação de longa duração.

Métodos

getOperationState()	Devolve o estado da operação.
getResult()	Devolve o valor do resultado da operação, independentemente do estado do poller. Pode devolver uma forma indefinida ou incompleta do valor final de TResult, dependendo da implementação.
isDone()	Os resultados são verdadeiros se o sondador já terminou a sondagem.
isStopped()	Os resultados são verdadeiros se o poller for parado.
onProgress((state: TState) => void)	Invoca o callback fornecido após cada sondagem ser concluída, enviando o estado atual da operação do poller. Devolve um método que pode ser usado para impedir de receber atualizações na função de callback dada.
poll({ abortSignal?: AbortSignalLike })	Devolve uma promessa que será resolvida assim que um único pedido de sondagem terminar. Faz isto chamando o método de atualização da operação do Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Devolve uma promessa que será resolvida assim que a operação subjacente for concluída.
serialize()	Devolve uma promessa que poderia ser usada para a versão serializada da operação do poller invocando o método de serialização da operação.
stopPolling()	Impede o sondador de continuar a votar. Por favor, note que isto só vai parar as sondagens do lado do cliente
submitted()	Espere que o sondador seja submetido.
toString()	Devolve uma cadeia representativa da operação do poller. Semelhante ao serializar, mas devolve uma cadeia.

Detalhes do Método

getOperationState()

Devolve o estado da operação.

function getOperationState(): TState

Regressos

TState

getResult()

Devolve o valor do resultado da operação, independentemente do estado do poller. Pode devolver uma forma indefinida ou incompleta do valor final de TResult, dependendo da implementação.

function getResult(): undefined | TResult

Regressos

undefined | TResult

isDone()

Os resultados são verdadeiros se o sondador já terminou a sondagem.

function isDone(): boolean

Regressos

boolean

isStopped()

Aviso

Esta API está agora obsoleta.

Use abortSignal status to track this instead.

Os resultados são verdadeiros se o poller for parado.

function isStopped(): boolean

Regressos

boolean

onProgress((state: TState) => void)

Invoca o callback fornecido após cada sondagem ser concluída, enviando o estado atual da operação do poller.

Devolve um método que pode ser usado para impedir de receber atualizações na função de callback dada.

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

Parâmetros

callback

(state: TState) => void

Regressos

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Devolve uma promessa que será resolvida assim que um único pedido de sondagem terminar. Faz isto chamando o método de atualização da operação do Poller.

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

Parâmetros

options

{ abortSignal?: AbortSignalLike }

Regressos

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Devolve uma promessa que será resolvida assim que a operação subjacente for concluída.

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

Parâmetros

pollOptions

{ abortSignal?: AbortSignalLike }

Regressos

Promise<TResult>

serialize()

Devolve uma promessa que poderia ser usada para a versão serializada da operação do poller invocando o método de serialização da operação.

function serialize(): Promise<string>

Regressos

Promise<string>

stopPolling()

Aviso

Esta API está agora obsoleta.

Use abortSignal to stop polling instead.

Impede o sondador de continuar a votar. Por favor, note que isto só vai parar as sondagens do lado do cliente

function stopPolling()

submitted()

Espere que o sondador seja submetido.

function submitted(): Promise<void>

Regressos

Promise<void>

toString()

Aviso

Esta API está agora obsoleta.

Use serialize() instead.

Devolve uma cadeia representativa da operação do poller. Semelhante ao serializar, mas devolve uma cadeia.

function toString(): string

Regressos

string