CreateHttpPollerOptions interface
Opções para createPoller.
Propriedades
| base |
O URL base a ser usado ao fazer solicitações. |
| interval |
Define quanto tempo o poller vai esperar antes de fazer uma nova solicitação ao serviço. |
| process |
Uma função para processar o resultado da LRO. |
| resolve |
Controle se deseja lançar uma exceção se a operação falhar ou foi cancelada. |
| resource |
A localização potencial do resultado da ORL, se especificada pela extensão da ORL no swagger. |
| restore |
Um poller serializado que pode ser usado para retomar uma operação de longa execução pausada existente. |
| skip |
Um sinalizador para ignorar a solicitação GET final que normalmente buscaria o recurso final |
| update |
Uma função para processar o estado da LRO. |
| with |
Uma função a ser chamada cada vez que o local da operação é atualizado pelo serviço. |
Detalhes de Propriedade
baseUrl
O URL base a ser usado ao fazer solicitações.
baseUrl?: string
Valor de Propriedade
string
intervalInMs
Define quanto tempo o poller vai esperar antes de fazer uma nova solicitação ao serviço.
intervalInMs?: number
Valor de Propriedade
number
processResult
Uma função para processar o resultado da LRO.
processResult?: (result: unknown, state: TState) => Promise<TResult>
Valor de Propriedade
(result: unknown, state: TState) => Promise<TResult>
resolveOnUnsuccessful
Controle se deseja lançar uma exceção se a operação falhar ou foi cancelada.
resolveOnUnsuccessful?: boolean
Valor de Propriedade
boolean
resourceLocationConfig
A localização potencial do resultado da ORL, se especificada pela extensão da ORL no swagger.
resourceLocationConfig?: ResourceLocationConfig
Valor de Propriedade
restoreFrom
Um poller serializado que pode ser usado para retomar uma operação de longa execução pausada existente.
restoreFrom?: string
Valor de Propriedade
string
skipFinalGet
Um sinalizador para ignorar a solicitação GET final que normalmente buscaria o recurso final
skipFinalGet?: boolean
Valor de Propriedade
boolean
updateState
Uma função para processar o estado da LRO.
updateState?: (state: TState, response: OperationResponse<unknown, RawRequest>) => void
Valor de Propriedade
(state: TState, response: OperationResponse<unknown, RawRequest>) => void
withOperationLocation
Uma função a ser chamada cada vez que o local da operação é atualizado pelo serviço.
withOperationLocation?: (operationLocation: string) => void
Valor de Propriedade
(operationLocation: string) => void