CreateHttpPollerOptions interface
Options de createPoller.
Propriétés
| base |
URL de base à utiliser lors de la formulation de requêtes. |
| interval |
Définit le temps d’attente de l’polleur avant d’effectuer une nouvelle requête au service. |
| process |
Fonction permettant de traiter le résultat du LRO. |
| resolve |
Déterminez s’il faut lever une exception si l’opération a échoué ou a été annulée. |
| resource |
Emplacement potentiel du résultat du LRO s’il est spécifié par l’extension LRO dans le swagger. |
| restore |
Un pollueur sérialisé qui peut être utilisé pour reprendre une opération longue en pause existante. |
| skip |
Un indicateur pour sauter la requête GET finale qui devrait normalement récupérer la ressource finale |
| update |
Fonction permettant de traiter l’état du LRO. |
| with |
Fonction à appeler chaque fois que l’emplacement de l’opération est mis à jour par le service. |
Détails de la propriété
baseUrl
URL de base à utiliser lors de la formulation de requêtes.
baseUrl?: string
Valeur de propriété
string
intervalInMs
Définit le temps d’attente de l’polleur avant d’effectuer une nouvelle requête au service.
intervalInMs?: number
Valeur de propriété
number
processResult
Fonction permettant de traiter le résultat du LRO.
processResult?: (result: unknown, state: TState) => Promise<TResult>
Valeur de propriété
(result: unknown, state: TState) => Promise<TResult>
resolveOnUnsuccessful
Déterminez s’il faut lever une exception si l’opération a échoué ou a été annulée.
resolveOnUnsuccessful?: boolean
Valeur de propriété
boolean
resourceLocationConfig
Emplacement potentiel du résultat du LRO s’il est spécifié par l’extension LRO dans le swagger.
resourceLocationConfig?: ResourceLocationConfig
Valeur de propriété
restoreFrom
Un pollueur sérialisé qui peut être utilisé pour reprendre une opération longue en pause existante.
restoreFrom?: string
Valeur de propriété
string
skipFinalGet
Un indicateur pour sauter la requête GET finale qui devrait normalement récupérer la ressource finale
skipFinalGet?: boolean
Valeur de propriété
boolean
updateState
Fonction permettant de traiter l’état du LRO.
updateState?: (state: TState, response: OperationResponse<unknown, RawRequest>) => void
Valeur de propriété
(state: TState, response: OperationResponse<unknown, RawRequest>) => void
withOperationLocation
Fonction à appeler chaque fois que l’emplacement de l’opération est mis à jour par le service.
withOperationLocation?: (operationLocation: string) => void
Valeur de propriété
(operationLocation: string) => void