PollOperationState interface

Pacote:

@azure/keyvault-keys

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

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

Ela deve ser atualizada 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 possam ser atualizadas por outros motivos.

Propriedades

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

Detalhes da propriedade

error

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

error?: Error

Valor da propriedade

Error

isCancelled

True se a operação tiver sido cancelada.

isCancelled?: boolean

Valor da propriedade

boolean

isCompleted

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

isCompleted?: boolean

Valor da propriedade

boolean

isStarted

True se a operação tiver sido iniciada.

isStarted?: boolean

Valor da propriedade

boolean

result

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

result?: TResult

Valor da propriedade

TResult