SimplePollerLike interface

パッケージ:

@azure/arm-compute

実行時間の長い操作をポーリングするために使用できる単純なポーリングツール。

メソッド

getOperationState()	操作の状態を返します。
getResult()	ポーリングの状態に関係なく、操作の結果値を返します。 実装によっては、未定義または不完全な形式の最終的な TResult 値を返すことができます。
isDone()	ポーリングが完了した場合は true を返します。
isStopped()	ポーリングが停止している場合は true を返します。
onProgress((state: TState) => void)	各ポーリング終了後に提供されたコールバックを呼び出し、ポーラーの現在の状態を送信します。 与えられたコールバック関数の更新を停止するためのメソッドを返します。
poll({ abortSignal?: AbortSignalLike })	単一のポーリングリクエストが完了すると解決する約束を返します。 これはポーラーの演算の更新メソッドを呼び出しることで行われます。
pollUntilDone({ abortSignal?: AbortSignalLike })	基礎操作が完了すると解決される約束を返します。
serialize()	操作のシリアライズメソッドを呼び出して、ポーラーの操作のシリアル化バージョンに使える約束を返します。
stopPolling()	これによりポーラーが投票を続けるのを止められます。 なお、これはクライアント側の投票を停止するだけです
submitted()	ポーラーの提出を待ちましょう。
toString()	ポーラーの操作の文字列表現を返します。 serializeに似ていますが、文字列を返します。

メソッドの詳細

getOperationState()

操作の状態を返します。

function getOperationState(): TState

返品

TState

getResult()

ポーリングの状態に関係なく、操作の結果値を返します。 実装によっては、未定義または不完全な形式の最終的な TResult 値を返すことができます。

function getResult(): undefined | TResult

返品

undefined | TResult

isDone()

ポーリングが完了した場合は true を返します。

function isDone(): boolean

返品

boolean

isStopped()

警告

この API は非推奨になりました。

Use abortSignal status to track this instead.

ポーリングが停止している場合は true を返します。

function isStopped(): boolean

返品

boolean

onProgress((state: TState) => void)

各ポーリング終了後に提供されたコールバックを呼び出し、ポーラーの現在の状態を送信します。

与えられたコールバック関数の更新を停止するためのメソッドを返します。

function onProgress(callback: (state: TState) => void): CancelOnProgress

パラメーター

callback

(state: TState) => void

返品

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

単一のポーリングリクエストが完了すると解決する約束を返します。 これはポーラーの演算の更新メソッドを呼び出しることで行われます。

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>

パラメーター

options

{ abortSignal?: AbortSignalLike }

返品

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

基礎操作が完了すると解決される約束を返します。

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

パラメーター

pollOptions

{ abortSignal?: AbortSignalLike }

返品

Promise<TResult>

serialize()

操作のシリアライズメソッドを呼び出して、ポーラーの操作のシリアル化バージョンに使える約束を返します。

function serialize(): Promise<string>

返品

Promise<string>

stopPolling()

警告

この API は非推奨になりました。

Use abortSignal to stop polling instead.

これによりポーラーが投票を続けるのを止められます。 なお、これはクライアント側の投票を停止するだけです

function stopPolling()

submitted()

ポーラーの提出を待ちましょう。

function submitted(): Promise<void>

返品

Promise<void>

toString()

警告

この API は非推奨になりました。

Use serialize() instead.

ポーラーの操作の文字列表現を返します。 serializeに似ていますが、文字列を返します。

function toString(): string

返品

string