PollOperationState interface

Pacote:

@azure/keyvault-keys

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

Enquanto a classe Poller funciona como o mecanismo de controlo local para começar a acionar, aguardar e potencialmente cancelar uma operação de execução prolongada, o PollOperationState documenta o estado da operação de execução prolongada remota.

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

Propriedades

error	Existirá se a operação tiver encontrado algum erro.
isCancelled	Verdadeiro se a operação tiver sido cancelada.
isCompleted	Verdadeiro se a operação tiver sido concluída.
isStarted	Verdadeiro se a operação tiver sido iniciada.
result	Existirá se a operação for concluída em resultado de um tipo esperado.

Detalhes de Propriedade

error

Existirá se a operação tiver encontrado algum erro.

error?: Error

Valor de Propriedade

Error

isCancelled

Verdadeiro se a operação tiver sido cancelada.

isCancelled?: boolean

Valor de Propriedade

boolean

isCompleted

Verdadeiro se a operação tiver sido concluída.

isCompleted?: boolean

Valor de Propriedade

boolean

isStarted

Verdadeiro se a operação tiver sido iniciada.

isStarted?: boolean

Valor de Propriedade

boolean

result

Existirá se a operação for concluída em resultado de um tipo esperado.

result?: TResult

Valor de Propriedade

TResult