SimplePollerLike interface

Pacote:

@azure-rest/developer-devcenter

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

Métodos

getOperationState()	Retorna o estado da operação.
getResult()	Retorna o valor do resultado da operação, independentemente do estado do sondador. Ele pode retornar uma forma indefinida ou incompleta do valor TResult final, dependendo da implementação.
isDone()	Retornará true se o sondador tiver terminado a votação.
isStopped()	Retornará true se o poller for interrompido.
onProgress((state: TState) => void)	Invoca o retorno de chamada fornecido após a conclusão de cada sondagem, enviando o estado atual da operação do sondador. Ele retorna um método que pode ser usado para parar de receber atualizações na função de retorno de chamada fornecida.
poll({ abortSignal?: AbortSignalLike })	Retorna uma promessa que será resolvida quando uma única solicitação de sondagem for concluída. Ele faz isso chamando o método de atualização da operação do Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Retorna uma promessa que será resolvida quando a operação subjacente for concluída.
serialize()	Retorna uma promessa que pode ser usada para a versão serializada da operação do sondador invocando o método de serialização da operação.
stopPolling()	Impede que o sondador continue a sondar. Observe que isso só interromperá a sondagem do lado do cliente
submitted()	Aguarde o sondador ser enviado.
toString()	Retorna uma representação de cadeia de caracteres da operação do poller. Semelhante a serializar, mas retorna uma cadeia de caracteres.

Detalhes do método

getOperationState()

Retorna o estado da operação.

function getOperationState(): TState

Retornos

TState

getResult()

Retorna o valor do resultado da operação, independentemente do estado do sondador. Ele pode retornar uma forma indefinida ou incompleta do valor TResult final, dependendo da implementação.

function getResult(): undefined | TResult

Retornos

undefined | TResult

isDone()

Retornará true se o sondador tiver terminado a votação.

function isDone(): boolean

Retornos

boolean

isStopped()

Aviso

Essa API foi preterida.

Use abortSignal status to track this instead.

Retornará true se o poller for interrompido.

function isStopped(): boolean

Retornos

boolean

onProgress((state: TState) => void)

Invoca o retorno de chamada fornecido após a conclusão de cada sondagem, enviando o estado atual da operação do sondador.

Ele retorna um método que pode ser usado para parar de receber atualizações na função de retorno de chamada fornecida.

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

Parâmetros

callback

(state: TState) => void

Retornos

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Retorna uma promessa que será resolvida quando uma única solicitação de sondagem for concluída. Ele faz isso chamando o método de atualização da operação do Poller.

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

Parâmetros

options

{ abortSignal?: AbortSignalLike }

Retornos

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

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

Parâmetros

pollOptions

{ abortSignal?: AbortSignalLike }

Retornos

Promise<TResult>

serialize()

Retorna uma promessa que pode ser usada para a versão serializada da operação do sondador invocando o método de serialização da operação.

function serialize(): Promise<string>

Retornos

Promise<string>

stopPolling()

Aviso

Essa API foi preterida.

Use abortSignal to stop polling instead.

Impede que o sondador continue a sondar. Observe que isso só interromperá a sondagem do lado do cliente

function stopPolling()

submitted()

Aguarde o sondador ser enviado.

function submitted(): Promise<void>

Retornos

Promise<void>

toString()

Aviso

Essa API foi preterida.

Use serialize() instead.

Retorna uma representação de cadeia de caracteres da operação do poller. Semelhante a serializar, mas retorna uma cadeia de caracteres.

function toString(): string

Retornos

string