Dizin
-
Operations
(arayüz) -
CancelOperationRequest
(mesaj) -
DeleteOperationRequest
(mesaj) -
GetOperationRequest
(mesaj) -
ListOperationsRequest
(mesaj) -
ListOperationsResponse
(mesaj) -
Operation
(mesaj) -
WaitOperationRequest
(mesaj)
Operasyonlar
Uzun süren operasyonları bir API hizmetiyle yönetir.
Bir API yönteminin tamamlanması normalde uzun zaman aldığında, Operation
müşteriye geri gönderecek şekilde tasarlanabilir ve müşteri, bu arayüzü, işlem kaynağını yoklayarak eşzamansız olarak gerçek yanıtı almak için kullanabilir veya işlem kaynağını başka bir API'ye aktarabilir ( Yanıtı almak için Pub/Sub API gibi) kullanın. Uzun süren işlemleri döndüren herhangi bir API hizmetinin, geliştiricilerin tutarlı bir istemci deneyimine sahip olabilmesi için Operations
arayüzünü uygulaması gerekir.
İşlemi İptal Et |
---|
Uzun süren bir işlemde eşzamansız iptali başlatır. Sunucu işlemi iptal etmek için elinden geleni yapar ancak başarı garanti edilmez. Sunucu bu yöntemi desteklemiyorsa
|
İşlemi Sil |
---|
Uzun süredir devam eden bir işlemi siler. Bu yöntem müşterinin artık operasyon sonucuyla ilgilenmediğini gösterir. İşlemi iptal etmez. Sunucu bu yöntemi desteklemiyorsa
|
GetOperation |
---|
Uzun süren bir işlemin en son durumunu alır. İstemciler, API hizmetinin önerdiği aralıklarla işlem sonucunu yoklamak için bu yöntemi kullanabilir.
|
İşlemleri Listele |
---|
İstekte belirtilen filtreyle eşleşen işlemleri listeler. Sunucu bu yöntemi desteklemiyorsa
|
Bekleİşlem |
---|
Belirtilen uzun süren işlem tamamlanana veya en fazla belirli bir zaman aşımına ulaşana kadar bekler ve en son durumu döndürür. İşlem zaten yapılmışsa en son durum hemen döndürülür. Belirtilen zaman aşımı, varsayılan HTTP/RPC zaman aşımından büyükse, HTTP/RPC zaman aşımı kullanılır. Sunucu bu yöntemi desteklemiyorsa
|
İşlem İsteğini İptal Et
Operations.CancelOperation
için istek mesajı.
Alanlar | |
---|---|
name | İptal edilecek işlem kaynağının adı. |
İşlem İsteğini Sil
Operations.DeleteOperation
için istek mesajı.
Alanlar | |
---|---|
name | Silinecek işlem kaynağının adı. |
GetOperationRequest
Operations.GetOperation
için istek mesajı.
Alanlar | |
---|---|
name | Operasyon kaynağının adı. |
ListeOperasyonTalebi
Operations.ListOperations
için istek mesajı.
Alanlar | |
---|---|
name | Operasyonun üst kaynağının adı. |
filter | Standart liste filtresi. |
page_size | Standart liste sayfası boyutu. |
page_token | Standart liste sayfası jetonu. |
ListeOperasyonlarYanıt
Operations.ListOperations
için yanıt iletisi.
Alanlar | |
---|---|
operations[] | İstekte belirtilen filtreyle eşleşen işlemlerin listesi. |
next_page_token | Standart Sonraki sayfa belirtecini listele. |
Operasyon
Bu kaynak, bir ağ API çağrısının sonucu olan uzun süreli bir işlemi temsil eder.
Alanlar | |
---|---|
name | Yalnızca orijinal olarak onu döndüren hizmet içinde benzersiz olan, sunucu tarafından atanan ad. Varsayılan HTTP eşlemesini kullanırsanız |
metadata | İşlemle ilişkili hizmete özgü meta veriler. Genellikle ilerleme bilgilerini ve oluşturma zamanı gibi ortak meta verileri içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süren bir işlemi döndüren herhangi bir yöntem, varsa meta veri türünü belgelemelidir. |
done | Değer |
Birleşim alanı result . Bir error ya da geçerli bir response olabilecek işlem sonucu. Eğer done == false ne error ne de response ayarlanır. Eğer done == true , tam olarak bir error veya response ayarlanabilir. Bazı hizmetler sonuç vermeyebilir. result aşağıdakilerden yalnızca biri olabilir: | |
error | Arıza veya iptal durumunda işlemin hata sonucu. |
response | Operasyonun normal, başarılı yanıtı. Orijinal yöntem başarı durumunda hiçbir veri döndürmezse (örneğin, |
BekleİşlemTalebi
Operations.WaitOperation
için istek mesajı.
Alanlar | |
---|---|
name | Beklenecek işlem kaynağının adı. |
timeout | Zaman aşımına uğramadan önce beklenecek maksimum süre. Boş bırakılırsa bekleme süresi en fazla temel HTTP/RPC protokolünün izin verdiği süre kadar olacaktır. RPC bağlamı için son tarih de belirtilirse, daha kısa olanı kullanılacaktır. |