Partilhar via


LROPoller Classe

Poller para operações de execução prolongada.

Herança
LROPoller

Construtor

LROPoller(client: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co], polling_method: PollingMethod[PollingReturnType_co])

Parâmetros

Name Description
client
Necessário

Um cliente de serviço de pipeline

initial_response
Necessário

A resposta inicial da chamada

deserialization_callback
Necessário
callable ou <xref:msrest.serialization.Model>

Uma chamada de retorno que recebe uma Resposta e devolve um objeto serializado sem serialização. Se for fornecida uma subclasse de Modelo, esta ação transmite "anular a serialização" como chamada de retorno.

polling_method
Necessário

A estratégia de consulta a adotar

Métodos

add_done_callback

Adicione a função de chamada de retorno a ser executada assim que a operação de execução prolongada estiver concluída, independentemente do estado da operação.

continuation_token

Devolver um token de continuação que permite reiniciar o poller mais tarde.

done

Verifique o estado da operação de execução prolongada.

from_continuation_token
polling_method

Devolver o método de consulta associado a este poller.

remove_done_callback

Remova uma chamada de retorno da operação de execução prolongada.

result

Devolver o resultado da operação de execução prolongada ou o resultado disponível após o tempo limite especificado.

status

Devolve a cadeia de estado atual.

wait

Aguarde pela operação de execução prolongada durante um período de tempo especificado. Pode verificar se esta chamada terminou com o tempo limite com o método "done()".

add_done_callback

Adicione a função de chamada de retorno a ser executada assim que a operação de execução prolongada estiver concluída, independentemente do estado da operação.

add_done_callback(func: Callable) -> None

Parâmetros

Name Description
func
Necessário

Função de chamada de retorno que utiliza, pelo menos, um argumento, uma LongRunningOperation concluída.

continuation_token

Devolver um token de continuação que permite reiniciar o poller mais tarde.

continuation_token() -> str

Devoluções

Tipo Description
str

Um token de continuação opaco

done

Verifique o estado da operação de execução prolongada.

done() -> bool

Devoluções

Tipo Description

"Verdadeiro" se o processo tiver sido concluído, senão "Falso".

from_continuation_token

from_continuation_token(polling_method: PollingMethod[PollingReturnType_co], continuation_token: str, **kwargs: Any) -> LROPoller[PollingReturnType_co]

Parâmetros

Name Description
polling_method
Necessário
continuation_token
Necessário

polling_method

Devolver o método de consulta associado a este poller.

polling_method() -> PollingMethod[PollingReturnType_co]

Devoluções

Tipo Description

O método de consulta

remove_done_callback

Remova uma chamada de retorno da operação de execução prolongada.

remove_done_callback(func: Callable) -> None

Parâmetros

Name Description
func
Necessário

A função a ser removida das chamadas de retorno.

Exceções

Tipo Description

se a operação de execução prolongada já tiver sido concluída.

result

Devolver o resultado da operação de execução prolongada ou o resultado disponível após o tempo limite especificado.

result(timeout: float | None = None) -> PollingReturnType_co

Parâmetros

Name Description
timeout

Período de tempo a aguardar antes de recuperar o controlo.

valor predefinido: None

Devoluções

Tipo Description
any,

O recurso desserializado da operação de execução prolongada, se estiver disponível.

Exceções

Tipo Description

Problema do servidor com a consulta.

status

Devolve a cadeia de estado atual.

status() -> str

Devoluções

Tipo Description
str

A cadeia de estado atual

wait

Aguarde pela operação de execução prolongada durante um período de tempo especificado. Pode verificar se esta chamada terminou com o tempo limite com o método "done()".

wait(timeout: float | None = None) -> None

Parâmetros

Name Description
timeout
Necessário

Período de tempo a aguardar pela conclusão da operação de execução prolongada (em segundos).

Exceções

Tipo Description

Problema do servidor com a consulta.