SimplePollerLike interface

Paket:

@azure-rest/purview-scanning

Poller sederhana yang dapat digunakan untuk melakukan polling operasi jangka panjang.

Metode

getOperationState()	Mengembalikan status operasi.
getResult()	Mengembalikan nilai hasil operasi, terlepas dari status poller. Ini dapat mengembalikan bentuk yang tidak ditentukan atau tidak lengkap dari nilai TResult akhir tergantung pada implementasinya.
isDone()	Mengembalikan true jika poller telah selesai melakukan polling.
isStopped()	Mengembalikan true jika poller dihentikan.
onProgress((state: TState) => void)	Memanggil panggilan balik yang disediakan setelah setiap polling selesai, mengirim status operasi poller saat ini. Ini mengembalikan metode yang dapat digunakan untuk berhenti menerima pembaruan pada fungsi panggilan balik yang diberikan.
poll({ abortSignal?: AbortSignalLike })	Mengembalikan janji yang akan diselesaikan setelah satu permintaan polling selesai. Ini dilakukan dengan memanggil metode pembaruan operasi Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Mengembalikan janji yang akan diselesaikan setelah operasi yang mendasar selesai.
serialize()	Mengembalikan janji yang dapat digunakan untuk versi berseri operasi poller dengan memanggil metode serialisasi operasi.
stopPolling()	Menghentikan poller untuk melanjutkan ke polling. Harap dicatat bahwa ini hanya akan menghentikan polling sisi klien
submitted()	Tunggu poller untuk dikirimkan.
toString()	Mengembalikan representasi string dari operasi poller. Mirip dengan serialisasi tetapi mengembalikan string.

Detail Metode

getOperationState()

Mengembalikan status operasi.

function getOperationState(): TState

Mengembalikan

TState

getResult()

Mengembalikan nilai hasil operasi, terlepas dari status poller. Ini dapat mengembalikan bentuk yang tidak ditentukan atau tidak lengkap dari nilai TResult akhir tergantung pada implementasinya.

function getResult(): undefined | TResult

Mengembalikan

undefined | TResult

isDone()

Mengembalikan true jika poller telah selesai melakukan polling.

function isDone(): boolean

Mengembalikan

boolean

isStopped()

Peringatan

API ini sudah tidak digunakan lagi.

Use abortSignal status to track this instead.

Mengembalikan true jika poller dihentikan.

function isStopped(): boolean

Mengembalikan

boolean

onProgress((state: TState) => void)

Memanggil panggilan balik yang disediakan setelah setiap polling selesai, mengirim status operasi poller saat ini.

Ini mengembalikan metode yang dapat digunakan untuk berhenti menerima pembaruan pada fungsi panggilan balik yang diberikan.

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

Parameter

callback

(state: TState) => void

Mengembalikan

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Mengembalikan janji yang akan diselesaikan setelah satu permintaan polling selesai. Ini dilakukan dengan memanggil metode pembaruan operasi Poller.

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

Parameter

options

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Mengembalikan janji yang akan diselesaikan setelah operasi yang mendasar selesai.

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

Parameter

pollOptions

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<TResult>

serialize()

Mengembalikan janji yang dapat digunakan untuk versi berseri operasi poller dengan memanggil metode serialisasi operasi.

function serialize(): Promise<string>

Mengembalikan

Promise<string>

stopPolling()

Peringatan

API ini sudah tidak digunakan lagi.

Use abortSignal to stop polling instead.

Menghentikan poller untuk melanjutkan ke polling. Harap dicatat bahwa ini hanya akan menghentikan polling sisi klien

function stopPolling()

submitted()

Tunggu poller untuk dikirimkan.

function submitted(): Promise<void>

Mengembalikan

Promise<void>

toString()

Peringatan

API ini sudah tidak digunakan lagi.

Use serialize() instead.

Mengembalikan representasi string dari operasi poller. Mirip dengan serialisasi tetapi mengembalikan string.

function toString(): string

Mengembalikan

string