CreateHttpPollerOptions interface
createPollerのオプション。
プロパティ
| interval |
ポーリング担当者がサービスに対して新しい要求を行う前に待機する時間を定義します。 |
| process |
LRO の結果を処理する関数。 |
| resolve |
操作が失敗した場合、または取り消された場合に例外をスローするかどうかを制御します。 |
| resource |
Swagger の LRO 拡張機能で指定されている場合の、LRO の結果の潜在的な場所。 |
| restore |
既存の一時停止された実行時間の長い操作を再開するために使用できるシリアル化されたポーリング ャー。 |
| update |
LRO の状態を処理する関数。 |
| with |
サービスによって操作の場所が更新されるたびに呼び出される関数。 |
プロパティの詳細
intervalInMs
ポーリング担当者がサービスに対して新しい要求を行う前に待機する時間を定義します。
intervalInMs?: numberプロパティ値
number
processResult
LRO の結果を処理する関数。
processResult?: (result: unknown, state: TState) => Promise<TResult>プロパティ値
(result: unknown, state: TState) => Promise<TResult>
resolveOnUnsuccessful
操作が失敗した場合、または取り消された場合に例外をスローするかどうかを制御します。
resolveOnUnsuccessful?: booleanプロパティ値
boolean
resourceLocationConfig
Swagger の LRO 拡張機能で指定されている場合の、LRO の結果の潜在的な場所。
resourceLocationConfig?: ResourceLocationConfigプロパティ値
restoreFrom
既存の一時停止された実行時間の長い操作を再開するために使用できるシリアル化されたポーリング ャー。
restoreFrom?: stringプロパティ値
string
updateState
LRO の状態を処理する関数。
updateState?: (state: TState, response: OperationResponse<unknown, RawRequest>) => voidプロパティ値
(state: TState, response: OperationResponse<unknown, RawRequest>) => void
withOperationLocation
サービスによって操作の場所が更新されるたびに呼び出される関数。
withOperationLocation?: (operationLocation: string) => voidプロパティ値
(operationLocation: string) => void
