CreateHttpPollerOptions interface
Options for createPoller.
Properties
| base |
The base URL to use when making requests. |
| interval |
Defines how much time the poller is going to wait before making a new request to the service. |
| process |
A function to process the result of the LRO. |
| resolve |
Control whether to throw an exception if the operation failed or was canceled. |
| resource |
The potential location of the result of the LRO if specified by the LRO extension in the swagger. |
| restore |
A serialized poller which can be used to resume an existing paused Long-Running-Operation. |
| skip |
A flag to skip the final GET request that would normally fetch the final resource |
| update |
A function to process the state of the LRO. |
| with |
A function to be called each time the operation location is updated by the service. |
Property Details
baseUrl
The base URL to use when making requests.
baseUrl?: stringProperty Value
string
intervalInMs
Defines how much time the poller is going to wait before making a new request to the service.
intervalInMs?: numberProperty Value
number
processResult
A function to process the result of the LRO.
processResult?: (result: unknown, state: TState) => Promise<TResult>Property Value
(result: unknown, state: TState) => Promise<TResult>
resolveOnUnsuccessful
Control whether to throw an exception if the operation failed or was canceled.
resolveOnUnsuccessful?: booleanProperty Value
boolean
resourceLocationConfig
The potential location of the result of the LRO if specified by the LRO extension in the swagger.
resourceLocationConfig?: ResourceLocationConfigProperty Value
restoreFrom
A serialized poller which can be used to resume an existing paused Long-Running-Operation.
restoreFrom?: stringProperty Value
string
skipFinalGet
A flag to skip the final GET request that would normally fetch the final resource
skipFinalGet?: booleanProperty Value
boolean
updateState
A function to process the state of the LRO.
updateState?: (state: TState, response: OperationResponse<unknown, RawRequest>) => voidProperty Value
(state: TState, response: OperationResponse<unknown, RawRequest>) => void
withOperationLocation
A function to be called each time the operation location is updated by the service.
withOperationLocation?: (operationLocation: string) => voidProperty Value
(operationLocation: string) => void