@azure/core-lro package
Sınıflar
LroEngine |
LRO Altyapısı, yoklama gerçekleştiren bir sınıf. |
Poller |
Tamamlanma durumuna ulaşana kadar ardışık istekler aracılığıyla yoklayan bir programın tanımını temsil eden sınıf. Bir poller, işlemi tamamlanana kadar isteği yoklayarak yöntemine art arda çağrılarak
Poller, iki türle tanımlanır. Bu tür, poller'ın durumunu temsil eden bir türdür. Bu tür, tarafından tanımlanan Poller sınıfı, poller uygulamalarının
Oluşturucu aracılığıyla bir poller oluşturulabilir, ardından tamamlanana kadar yoklanabilir. Herhangi bir zamanda, poller'ın durumu getOperationState yöntemi aracılığıyla gecikme olmadan elde edilebilir. Herhangi bir zamanda, sonuç türünün ara formları gecikmeden istenebilir. Temel alınan işlem tamamlandı olarak işaretlendikten sonra, poller durur ve son değer döndürülür.
|
PollerCancelledError |
İşlem iptal edildiğinde, poller PollerCancelledError örneğiyle reddedilir. |
PollerStoppedError |
Bir poller yöntemi aracılığıyla |
Arabirimler
CreateHttpPollerOptions |
için |
LongRunningOperation |
Uzun süre çalışan bir işlemin açıklaması. |
LroEngineOptions |
LRO poller için seçenekler. |
LroResponse |
LRO yanıtının türü. |
OperationState |
Poller, tetiklemeyi başlatmak ve uzun süre çalışan bir işlemi beklemek için yerel denetim mekanizması olarak çalışsa da, OperationState uzak uzun süre çalışan işlemin durumunu belgeler. Her anket sonrasında güncelleştirilir. |
PollOperation |
PollOperation, uzak uzun süre çalışan işlemin durumunun yerel başvurusunun nasıl güncelleştirildiğini ve aynı işlemin iptalinin nasıl istendiğini tanımlayan bir arabirimdir. Ayrıca, herhangi bir zamanda depolanabilmesi ve sürdürülebilmesi için işlemi seri hale getirmek için bir yöntemi vardır. |
PollOperationState |
PollOperationState, uzun süre çalışan işlem poller'lerini tanımlamak için gereken en küçük özellik kümesinin bir listesini içerir. Poller sınıfı, uzun süre çalışan bir işlemi tetikleme, bekleme ve potansiyel olarak iptal etme amacıyla yerel denetim mekanizması olarak çalışsa da PollOperationState, uzak uzun süre çalışan işlemin durumunu belgeler. En azından işlem başladığında, tamamlandığında ve iptal edildiğinde güncelleştirilmelidir. Ancak, uygulamalar başka nedenlerle güncelleştirilebilecek başka sayıda özelliğe sahip olabilir. |
PollerLike |
Kullanıcının çalışması gereken en düşük API'yi kullanıma sunma amacıyla bir poller'in soyut gösterimi. |
RawResponse |
Ham yanıtın basit türü. |
SimplePollerLike |
Basit bir poller arabirimi. |
Tür Diğer Adları
CancelOnProgress |
CancelOnProgress, Poller'ın onProgress yönteminin dönüş değeri olarak kullanılır. Bir kullanıcı onProgress'i çağırdığında, yoklama işlemi her güncelleştirildiğinde alınan yeni verilerle geri çağırma olarak çağrılacak bir işlev geçirmesi gerekir. onProgress, daha fazla güncelleştirmenin özgün geri çağırmaya ulaşmasını engelleyecek bir işlev döndürür. |
LroResourceLocationConfig |
Swagger'da LRO uzantısı tarafından belirtilirse LRO sonucunun olası konumu. |
OperationStatus |
Bir işlemin herhangi bir zamanda içinde bulunabileceği olası durum kümesi. |
PollProgressCallback |
PollProgressCallback, onProgress'e gönderilen geri çağırma işlevlerinin türüdür. Bu işlevler, Poller sınıfı uygulamanız tarafından tanımlanan bir TState alır. |
İşlevler
create |
Uzun süre çalışan bir işlemi yoklamada kullanılabilecek bir poller oluşturur. |
İşlev Ayrıntıları
createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Uzun süre çalışan bir işlemi yoklamada kullanılabilecek bir poller oluşturur.
function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>
Parametreler
- lro
-
LongRunningOperation<unknown>
Uzun süre çalışan işlemin açıklaması
- options
-
CreateHttpPollerOptions<TResult, TState>
poller yapılandırma seçenekleri
Döndürülenler
Promise<SimplePollerLike<TState, TResult>>
başlatılan bir poller