Operation

Bu kaynak, bir ağ API çağrısının sonucu olan 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 başlangıçta döndüren aynı hizmet içinde 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şkili hizmete özgü meta veriler. Genellikle ilerleme bilgileri ve oluşturma zamanı gibi ortak meta veriler içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süren bir işlem döndüren tüm yöntemler, varsa meta veri türünü belgelemelidir.

İstediğiniz türde alanlar içeren bir nesne. Ek bir alan "@type", 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 tamamlanır ve error veya response kullanılabilir.

Birleştirme alanı result. İşlem sonucu. error veya geçerli bir response olabilir. done == false ise ne error ne de response ayarlanır. done == true ise error veya response öğelerinden tam olarak biri ayarlanır. result yalnızca aşağıdakilerden biri olabilir:
error

object (Status)

Başarısızlık veya iptal durumunda işlemin hata sonucu.

response

object

İşlem başarılı olduğunda verilen normal yanıt. Orijinal yöntem başarıyla tamamlandığında veri döndürmüyorsa (ör. 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ıtta XxxResponse türü olmalıdır. Burada Xxx, orijinal yöntem adıdır. Örneğin, orijinal yöntem adı TakeSnapshot() ise çıkarılan yanıt türü TakeSnapshotResponse olur.

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

Durum

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

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

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

number

Durum kodu, google.rpc.Code numaralı enum değeri olmalıdır.

message

string

Geliştiricilere yönelik hata mesajı (İngilizce olmalıdır). Kullanıcıya gösterilen tüm hata mesajları yerelleştirilmeli ve 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 ortak bir ileti türleri kümesi vardır.

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