Package google.longrunning

Dizin

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

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

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 google.rpc.Code.UNIMPLEMENTED değerini döndürür. İstemciler, iptalin başarılı olup olmadığını veya işlemin iptale rağmen tamamlanıp tamamlanmadığını kontrol etmek için Operations.GetOperation veya diğer yöntemleri kullanabilir. Başarılı iptal durumunda işlem silinmez; bunun yerine, Code.CANCELLED karşılık gelen, google.rpc.Status.code 1 olan Operation.error değerine sahip bir işlem haline gelir.

Yetki kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.

İşlemi Sil

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

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 google.rpc.Code.UNIMPLEMENTED değerini döndürür.

Yetki kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.

GetOperation

rpc GetOperation( GetOperationRequest ) returns ( Operation )

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.

Yetki kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.

İşlemleri Listele

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

İstekte belirtilen filtreyle eşleşen işlemleri listeler. Sunucu bu yöntemi desteklemiyorsa UNIMPLEMENTED değerini döndürür.

Yetki kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.

Bekleİşlem

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

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 google.rpc.Code.UNIMPLEMENTED değerini döndürür. Bu yöntemin en iyi çaba esasına dayalı olduğunu unutmayın. Belirtilen zaman aşımından (hemen dahil) önceki en son durumu döndürebilir; bu, anında yanıt verilmesinin bile işlemin tamamlandığını garanti etmediği anlamına gelir.

Yetki kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.

İşlem İsteğini İptal Et

Operations.CancelOperation için istek mesajı.

Alanlar
name

string

İptal edilecek işlem kaynağının adı.

İşlem İsteğini Sil

Operations.DeleteOperation için istek mesajı.

Alanlar
name

string

Silinecek işlem kaynağının adı.

GetOperationRequest

Operations.GetOperation için istek mesajı.

Alanlar
name

string

Operasyon kaynağının adı.

ListeOperasyonTalebi

Operations.ListOperations için istek mesajı.

Alanlar
name

string

Operasyonun üst kaynağının adı.

filter

string

Standart liste filtresi.

page_size

int32

Standart liste sayfası boyutu.

page_token

string

Standart liste sayfası jetonu.

ListeOperasyonlarYanıt

Operations.ListOperations için yanıt iletisi.

Alanlar
operations[]

Operation

İstekte belirtilen filtreyle eşleşen işlemlerin listesi.

next_page_token

string

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

string

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 name , operations/{unique_id} ile biten bir kaynak adı olmalıdır.

metadata

Any

İş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

bool

Değer false ise işlemin halen devam ettiği anlamına gelir. true ise işlem tamamlanmıştır ve error ya da response mevcuttur.

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

Status

Arıza veya iptal durumunda işlemin hata sonucu.

response

Any

Operasyonun normal, başarılı yanıtı. Orijinal yöntem başarı durumunda hiçbir veri döndürmezse (örneğin, Delete , yanıt google.protobuf.Empty olur. Orijinal yöntem standart Get / Create / Update ise yanıt kaynak olmalıdır. Diğer yöntemler için yanıtın XxxResponse türünde olması gerekir; burada Xxx , orijinal yöntemin adıdır. Örneğin, orijinal yöntem adı TakeSnapshot() ise, çıkarılan yanıt türü TakeSnapshotResponse olur.

BekleİşlemTalebi

Operations.WaitOperation için istek mesajı.

Alanlar
name

string

Beklenecek işlem kaynağının adı.

timeout

Duration

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.