SimplePollerLike interface

Paket:

@azure-rest/arm-containerservice

Uzun süre çalışan bir işlemi yoklamada kullanılabilecek basit bir poller.

Yöntemler

getOperationState()	İşlemin durumunu döndürür.
getResult()	Poller'ın durumundan bağımsız olarak işlemin sonuç değerini döndürür. Uygulamaya bağlı olarak son TResult değerinin tanımlanmamış veya tamamlanmamış bir biçimini döndürebilir.
isDone()	Poller yoklamayı bitirdiyse true döndürür.
isStopped()	Poller durdurulursa true döndürür.
onProgress((state: TState) => void)	Her yoklama tamamlandıktan sonra sağlanan geri çağırmayı çağırır ve poller işleminin geçerli durumunu gönderir. Verilen geri çağırma işlevinde güncelleştirmeleri almayı durdurmak için kullanılabilecek bir yöntem döndürür.
poll({ abortSignal?: AbortSignalLike })	Tek bir yoklama isteği tamamlandığında çözülecek bir söz döndürür. Bunu, Poller'ın işleminin güncelleştirme yöntemini çağırarak yapar.
pollUntilDone({ abortSignal?: AbortSignalLike })	Temel alınan işlem tamamlandıktan sonra çözülecek bir söz döndürür.
serialize()	İşlemin seri hale getirme yöntemini çağırarak poller işleminin serileştirilmiş sürümü için kullanılabilecek bir söz döndürür.
stopPolling()	Poller'ın ankete devam etmelerini durdurur. Bunun yalnızca istemci tarafı yoklamasını durduracağını lütfen unutmayın
submitted()	Poller'ın gönderilmesini bekleyin.
toString()	Poller'ın işleminin dize gösterimini döndürür. Serileştirmeye benzer ancak bir dize döndürür.

Yöntem Ayrıntıları

getOperationState()

İşlemin durumunu döndürür.

function getOperationState(): TState

Döndürülenler

TState

getResult()

Poller'ın durumundan bağımsız olarak işlemin sonuç değerini döndürür. Uygulamaya bağlı olarak son TResult değerinin tanımlanmamış veya tamamlanmamış bir biçimini döndürebilir.

function getResult(): undefined | TResult

Döndürülenler

undefined | TResult

isDone()

Poller yoklamayı bitirdiyse true döndürür.

function isDone(): boolean

Döndürülenler

boolean

isStopped()

Uyarı

Bu API artık kullanım dışıdır.

Use abortSignal status to track this instead.

Poller durdurulursa true döndürür.

function isStopped(): boolean

Döndürülenler

boolean

onProgress((state: TState) => void)

Her yoklama tamamlandıktan sonra sağlanan geri çağırmayı çağırır ve poller işleminin geçerli durumunu gönderir.

Verilen geri çağırma işlevinde güncelleştirmeleri almayı durdurmak için kullanılabilecek bir yöntem döndürür.

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

Parametreler

callback

(state: TState) => void

Döndürülenler

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Tek bir yoklama isteği tamamlandığında çözülecek bir söz döndürür. Bunu, Poller'ın işleminin güncelleştirme yöntemini çağırarak yapar.

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

Parametreler

options

{ abortSignal?: AbortSignalLike }

Döndürülenler

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Temel alınan işlem tamamlandıktan sonra çözülecek bir söz döndürür.

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

Parametreler

pollOptions

{ abortSignal?: AbortSignalLike }

Döndürülenler

Promise<TResult>

serialize()

İşlemin seri hale getirme yöntemini çağırarak poller işleminin serileştirilmiş sürümü için kullanılabilecek bir söz döndürür.

function serialize(): Promise<string>

Döndürülenler

Promise<string>

stopPolling()

Uyarı

Bu API artık kullanım dışıdır.

Use abortSignal to stop polling instead.

Poller'ın ankete devam etmelerini durdurur. Bunun yalnızca istemci tarafı yoklamasını durduracağını lütfen unutmayın

function stopPolling()

submitted()

Poller'ın gönderilmesini bekleyin.

function submitted(): Promise<void>

Döndürülenler

Promise<void>

toString()

Uyarı

Bu API artık kullanım dışıdır.

Use serialize() instead.

Poller'ın işleminin dize gösterimini döndürür. Serileştirmeye benzer ancak bir dize döndürür.

function toString(): string

Döndürülenler

string