@azure/core-lro package

O Mecanismo LRO, uma classe que executa sondagem.

Uma classe que representa a definição de um programa que sonda por solicitações consecutivas até atingir um estado de conclusão.

Um sondador pode ser executado manualmente, por solicitação de sondagem por solicitação chamando o poll() método repetidamente, até que sua operação seja concluída. Ele também fornece uma maneira de aguardar até que a operação seja concluída, chamando pollUntilDone() e aguardando até que a operação seja concluída. Os sondadores também podem solicitar o cancelamento do processo em andamento para quem está fornecendo a operação subjacente de execução longa.

const poller = new MyPoller();

// Polling just once:
await poller.poll();

// We can try to cancel the request here, by calling:
//
//     await poller.cancelOperation();
//

// Getting the final result:
const result = await poller.pollUntilDone();

O Poller é definido por dois tipos, um tipo que representa o estado do sondador, que deve incluir um conjunto básico de propriedades de e um tipo de PollOperationState<TResult>retorno definido por TResult, que pode ser qualquer coisa.

A classe Poller implementa a PollerLike interface , que permite que as implementações do poller evitem ter que exportar a classe do Poller diretamente e, em vez disso, exportar apenas o poller já instanciado com o tipo PollerLike.

class Client {
  public async makePoller: PollerLike<MyOperationState, MyResult> {
    const poller = new MyPoller({});
    // It might be preferred to return the poller after the first request is made,
    // so that some information can be obtained right away.
    await poller.poll();
    return poller;
  }
}

const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller();

Um sondador pode ser criado por meio de seu construtor e, em seguida, ele pode ser sondado até ser concluído. A qualquer momento, o estado do sondador pode ser obtido sem demora por meio do método getOperationState. A qualquer momento, as formas intermediárias do tipo de resultado podem ser solicitadas sem demora. Depois que a operação subjacente for marcada como concluída, o sondador será interrompido e o valor final será retornado.

const poller = myClient.makePoller();
const state: MyOperationState = poller.getOperationState();

// The intermediate result can be obtained at any time.
const result: MyResult | undefined = poller.getResult();

// The final result can only be obtained after the poller finishes.
const result: MyResult = await poller.pollUntilDone();

Quando a operação for cancelada, o sondador será rejeitado com uma instância do PollerCancelledError.

Quando um sondador é interrompido manualmente por meio do stopPolling método , o sondador será rejeitado com uma instância do PollerStoppedError.

Opções para createPoller.

Descrição de uma operação de execução prolongada.

Opções para o polidor LRO.

O tipo da resposta de um LRO.

Enquanto o sondador funciona como o mecanismo de controle local para começar a disparar e aguardar uma operação de longa execução, OperationState documenta o status da operação remota de longa execução. Ele é atualizado após cada votação.

PollOperation é uma interface que define como atualizar a referência local do estado da operação de execução longa remota, bem como como solicitar o cancelamento da mesma operação.

Ele também tem um método para serializar a operação para que ela possa ser armazenada e retomada a qualquer momento.

PollOperationState contém uma lista opinativa do menor conjunto de propriedades necessário para definir qualquer sondador de operação de execução prolongada.

Embora a classe Poller funcione como o mecanismo de controle local para começar a disparar, aguardar e potencialmente cancelar uma operação de execução prolongada, o PollOperationState documenta o status da operação remota de execução longa.

Ele deve ser atualizado pelo menos quando a operação for iniciada, quando for concluída e quando for cancelada. No entanto, as implementações podem ter qualquer outro número de propriedades que podem ser atualizadas por outros motivos.

Representação abstrata de um sondador, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar.

Tipo simples da resposta bruta.

Uma interface de sondagem simples.

CancelOnProgress é usado como o valor retornado do método onProgress de um Poller. Quando um usuário invoca onProgress, ele precisa passar uma função que será chamada como um retorno de chamada com os novos dados recebidos sempre que a operação de sondagem for atualizada. onProgress retorna uma função que impedirá que qualquer atualização adicional alcance o retorno de chamada original.

O local potencial do resultado do LRO, se especificado pela extensão LRO no swagger.

O conjunto de possíveis estados em que uma operação pode estar a qualquer momento.

PollProgressCallback é o tipo das funções de retorno de chamada enviadas para onProgress. Essas funções receberão um TState definido pela implementação da classe Poller.

Cria um sondador que pode ser usado para sondar uma operação de longa duração.