REST Resource: operations

Kaynak: İşlem

Bu kaynak, bir ağ API çağrısı sonucunda gerçekleşen uzun süreli bir işlemi temsil eder.

JSON gösterimi 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Alanlar
name

string

Sunucu tarafından atanan ad; bu ad, yalnızca onu ilk döndüren hizmette benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız name, operations/{unique_id} ile biten bir kaynak adı olmalıdır.
metadata

object

İşlemle ilişkilendirilen hizmete özgü meta veriler. Genellikle ilerleme bilgilerini ve oluşturma zamanı gibi yaygın meta verileri içerir. Bazı hizmetler bu tür meta veriler sağlamayabilir. Uzun süreli bir işlem döndüren yöntemler, varsa meta veri türünü belgelemelidir.

Rastgele türde alanlar içeren bir nesne. "@type" adlı ek alan, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Değer false ise işlemin devam ettiği anlamına gelir. true ise işlem tamamlanmıştır ve error veya response kullanılabilir.
result alanı. error veya geçerli bir response olabilecek işlem sonucu. done == false ise ne error ne de response ayarlanır. done == true ise error veya response değerlerinden tam olarak biri ayarlanabilir. Bazı hizmetler sonucu sağlamayabilir. result şunlardan yalnızca biri olabilir:
error

object (Status)

Hata veya iptal durumunda işlemin hata sonucu.
response

object

İşlemin normal, başarılı yanıtı. Orijinal yöntem, Delete gibi başarıyla ilgili veri döndürmezse 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 XxxResponse türünde olmalıdır; burada Xxx, orijinal yöntemin adıdır. Örneğin, orijinal yöntemin adı TakeSnapshot() ise tahmin edilen yanıt türü TakeSnapshotResponse olur.

Rastgele türde alanlar içeren bir nesne. "@type" adlı ek alan, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

Durum

Status türü, REST API'ler ve RPC API'leri dahil olmak üzere farklı programlama ortamları için uygun bir mantıksal hata modeli tanımlar. gRPC tarafından kullanılır. Her Status mesajı üç veri parçası içerir: hata kodu, hata mesajı ve hata ayrıntıları.

Bu hata modeli ve modelle nasıl çalışılacağı hakkında daha fazla bilgiyi API Tasarım Kılavuzu'nda bulabilirsiniz.

JSON gösterimi 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Alanlar
code

integer

google.rpc.Code değerinin enum değeri olması gereken durum kodu.
message

string

Geliştiricinin karşılaştığı İngilizce hata mesajı. Kullanıcılara yönelik tüm hata mesajları yerelleştirilip google.rpc.Status.details alanında gönderilmeli veya istemci tarafından yerelleştirilmelidir.
details[]

object

Hata ayrıntılarını içeren mesajların listesi. API'lerin kullanabileceği yaygın bir dizi mesaj türü vardır.

Rastgele türde alanlar içeren bir nesne. "@type" adlı ek alan, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

Yöntemler

cancel

 Uzun süreli bir işlemde eşzamansız iptali başlatır.

delete

 Uzun süren bir işlemi siler.

get

 Uzun süreli bir işlemin en son durumunu alır.

list

 İstekte belirtilen filtreyle eşleşen işlemleri listeler.