Share via

@azure/core-lro package

  • Referensi

Kelas

LroEngine

Mesin LRO, kelas yang melakukan polling.
Poller

Kelas yang mewakili definisi program yang melakukan polling melalui permintaan berturut-turut hingga mencapai status penyelesaian.

Poller dapat dijalankan secara manual, dengan melakukan polling permintaan berdasarkan permintaan dengan memanggil metode poll() berulang kali, sampai operasinya selesai. Ini juga menyediakan cara untuk menunggu sampai operasi selesai, dengan memanggil pollUntilDone() dan menunggu sampai operasi selesai. Poller juga dapat meminta pembatalan proses yang sedang berlangsung kepada siapa yang menyediakan operasi jangka panjang yang mendasar.

const poller = new MyPoller();

// Polling just once:
await poller.poll();

// We can try to cancel the request here, by calling:
//
//     await poller.cancelOperation();
//

// Getting the final result:
const result = await poller.pollUntilDone();

Poller didefinisikan oleh dua jenis, jenis yang mewakili status poller, yang harus menyertakan sekumpulan properti dasar dari PollOperationState<TResult>, dan jenis pengembalian yang ditentukan oleh TResult, yang dapat berupa apa pun.

Kelas Poller mengimplementasikan PollerLike antarmuka , yang memungkinkan implementasi poller untuk menghindari harus mengekspor kelas Poller secara langsung, dan sebaliknya hanya mengekspor poller yang sudah dibuat dengan jenis PollerLike.

class Client {
  public async makePoller: PollerLike<MyOperationState, MyResult> {
    const poller = new MyPoller({});
    // It might be preferred to return the poller after the first request is made,
    // so that some information can be obtained right away.
    await poller.poll();
    return poller;
  }
}

const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller();

Poller dapat dibuat melalui konstruktornya, kemudian dapat dijajaki sampai selesai. Kapan saja, status poller dapat diperoleh tanpa penundaan melalui metode getOperationState. Kapan saja, bentuk perantara dari jenis hasil dapat diminta tanpa penundaan. Setelah operasi yang mendasar ditandai sebagai selesai, poller akan berhenti dan nilai akhir akan dikembalikan.

const poller = myClient.makePoller();
const state: MyOperationState = poller.getOperationState();

// The intermediate result can be obtained at any time.
const result: MyResult | undefined = poller.getResult();

// The final result can only be obtained after the poller finishes.
const result: MyResult = await poller.pollUntilDone();
PollerCancelledError

Ketika operasi dibatalkan, poller akan ditolak dengan instans PollerCancelledError.
PollerStoppedError

Ketika poller dihentikan secara manual melalui stopPolling metode , poller akan ditolak dengan instans PollerStoppedError.

Antarmuka

CreateHttpPollerOptions

Opsi untuk createPoller.
LongRunningOperation

Deskripsi operasi yang berjalan lama.
LroEngineOptions

Opsi untuk poller LRO.
LroResponse

Jenis respons LRO.
OperationState

Sementara poller berfungsi sebagai mekanisme kontrol lokal untuk mulai memicu dan menunggu operasi yang berjalan lama, OperationState mendandani status operasi jangka panjang jarak jauh. Ini akan diperbarui setelah setiap polling.
PollOperation

PollOperation adalah antarmuka yang menentukan cara memperbarui referensi lokal status operasi jangka panjang jarak jauh, serta cara meminta pembatalan operasi yang sama.

Ini juga memiliki metode untuk menserialisasikan operasi sehingga dapat disimpan dan dilanjutkan kapan saja.
PollOperationState

PollOperationState berisi daftar berpendapat dari sekumpulan properti terkecil yang diperlukan untuk menentukan poller operasi yang berjalan lama.

Sementara kelas Poller berfungsi sebagai mekanisme kontrol lokal untuk mulai memicu, menunggu, dan berpotensi membatalkan operasi yang berjalan lama, PollOperationState mendandani status operasi jangka panjang jarak jauh.

Ini harus diperbarui setidaknya ketika operasi dimulai, ketika selesai, dan ketika dibatalkan. Meskipun, implementasi dapat memiliki sejumlah properti lain yang dapat diperbarui dengan alasan lain.
PollerLike

Representasi abstrak dari poller, dimaksudkan untuk mengekspos API minimal yang perlu digunakan pengguna.
RawResponse

Jenis respons mentah yang sederhana.
SimplePollerLike

Antarmuka poller sederhana.

Alias Jenis

CancelOnProgress

CancelOnProgress digunakan sebagai nilai pengembalian metode onProgress Poller. Saat pengguna memanggil onProgress, mereka diharuskan untuk meneruskan fungsi yang akan dipanggil sebagai panggilan balik dengan data baru yang diterima setiap kali operasi polling diperbarui. onProgress mengembalikan fungsi yang akan mencegah pembaruan lebih lanjut untuk mencapai panggilan balik asli.
LroResourceLocationConfig

Lokasi potensial dari hasil LRO jika ditentukan oleh ekstensi LRO di swagger.
OperationStatus

Kumpulan kemungkinan status operasi dapat berada di pada waktu tertentu.
PollProgressCallback

PollProgressCallback adalah jenis fungsi panggilan balik yang dikirim ke onProgress. Fungsi-fungsi ini akan menerima TState yang ditentukan oleh implementasi kelas Poller Anda.

Fungsi

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Membuat poller yang dapat digunakan untuk melakukan polling operasi yang berjalan lama.

Detail Fungsi

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Membuat poller yang dapat digunakan untuk melakukan polling operasi yang berjalan lama.

function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>

Parameter

lro

LongRunningOperation<unknown>

Deskripsi operasi jangka panjang

options

CreateHttpPollerOptions<TResult, TState>

opsi untuk mengonfigurasi poller

Mengembalikan

Promise<SimplePollerLike<TState, TResult>>

poller yang diinisialisasi