CreateHttpPollerOptions interface
Opcje createPoller.
Właściwości
| base |
Podstawowy adres URL, który ma być używany podczas wysyłania żądań. |
| interval |
Określa, ile czasu będzie czekać poller przed utworzeniem nowego żądania do usługi. |
| process |
Funkcja przetwarzania wyniku LRO. |
| resolve |
Określ, czy zgłosić wyjątek, jeśli operacja nie powiodła się, czy została anulowana. |
| resource |
Potencjalna lokalizacja wyniku LRO, jeśli jest określona przez rozszerzenie LRO w strukturze Swagger. |
| restore |
Serializowany poller, który może służyć do wznowienia istniejącej wstrzymanej długotrwałej operacji. |
| skip |
Flaga umożliwiająca pominięcie końcowego żądania GET, które normalnie pobrałoby końcowy zasób |
| update |
Funkcja do przetwarzania stanu LRO. |
| with |
Funkcja, która ma być wywoływana za każdym razem, gdy lokalizacja operacji jest aktualizowana przez usługę. |
Szczegóły właściwości
baseUrl
Podstawowy adres URL, który ma być używany podczas wysyłania żądań.
baseUrl?: string
Wartość właściwości
string
intervalInMs
Określa, ile czasu będzie czekać poller przed utworzeniem nowego żądania do usługi.
intervalInMs?: number
Wartość właściwości
number
processResult
Funkcja przetwarzania wyniku LRO.
processResult?: (result: unknown, state: TState) => Promise<TResult>
Wartość właściwości
(result: unknown, state: TState) => Promise<TResult>
resolveOnUnsuccessful
Określ, czy zgłosić wyjątek, jeśli operacja nie powiodła się, czy została anulowana.
resolveOnUnsuccessful?: boolean
Wartość właściwości
boolean
resourceLocationConfig
Potencjalna lokalizacja wyniku LRO, jeśli jest określona przez rozszerzenie LRO w strukturze Swagger.
resourceLocationConfig?: ResourceLocationConfig
Wartość właściwości
restoreFrom
Serializowany poller, który może służyć do wznowienia istniejącej wstrzymanej długotrwałej operacji.
restoreFrom?: string
Wartość właściwości
string
skipFinalGet
Flaga umożliwiająca pominięcie końcowego żądania GET, które normalnie pobrałoby końcowy zasób
skipFinalGet?: boolean
Wartość właściwości
boolean
updateState
Funkcja do przetwarzania stanu LRO.
updateState?: (state: TState, response: OperationResponse<unknown, RawRequest>) => void
Wartość właściwości
(state: TState, response: OperationResponse<unknown, RawRequest>) => void
withOperationLocation
Funkcja, która ma być wywoływana za każdym razem, gdy lokalizacja operacji jest aktualizowana przez usługę.
withOperationLocation?: (operationLocation: string) => void
Wartość właściwości
(operationLocation: string) => void