REST Resource: operations

Kaynak: İşlem

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; yalnızca başlangıçta döndürdüğü hizmetin 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

İşlem claimAsync, unclaimAsync veya updateMetadataAsync tarafından oluşturulursa bu alan bir DevicesLongRunningOperationMetadata nesnesi içerir.

Rastgele tür alanlarını içeren bir nesne. Ek alan ("@type"), türü tanımlayan bir URI içeriyor. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Değer false ise işlem devam ediyor demektir. true ise işlem tamamlanır ve error veya response kullanılabilir.
Birlik alanı result. İşlem sonucu. Bu, error veya geçerli bir response olabilir. done = false ise ne error ne de response ayarlanmadı. done = true ise error veya response tam olarak ayarlanabilir. Bazı hizmetler sonucu sağlamayabilir. result aşağıdakilerden yalnızca biri olabilir:
error

object (Status)

İşlem claimAsync, unclaimAsync veya updateMetadataAsync tarafından oluşturulduysa bu alan her zaman ayarlanmaz. Bu durumda, her cihazın hata bilgileri response.perDeviceStatus.result.status olarak ayarlanır.
response

object

İşlem claimAsync, unclaimAsync veya updateMetadataAsync tarafından oluşturulursa bu alan bir DevicesLongRunningOperationResponse nesnesi içerir.

Rastgele tür alanlarını içeren bir nesne. Ek alan ("@type"), türü tanımlayan bir URI içeriyor. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

Durum

Status türü, REST API'leri ve TBS API'leri dahil olmak üzere farklı programlama ortamları için uygun olan bir mantıksal hata modelini tanımlar. gTB tarafından kullanılır. Her Status mesajı üç hata verisinden oluşur: hata kodu, hata mesajı ve hata ayrıntıları.

Bu hata modeli ve nasıl çalışılacağı hakkında daha fazla bilgiye API Tasarım Kılavuzu'ndan ulaşabilirsiniz.

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

integer

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

string

Geliştiriciye yönelik hata mesajı (İngilizce olmalıdır). Kullanıcıya yönelik hata mesajlarının yerelleştirilip google.rpc.Status.details alanına gönderilmesi veya istemci tarafından yerelleştirilmesi gerekir.
details[]

object

Hata ayrıntılarını içeren iletilerin listesi. API'lerin kullanması gereken yaygın bir mesaj türü grubu vardır.

Rastgele tür alanlarını içeren bir nesne. Ek alan ("@type"), türü tanımlayan bir URI içeriyor. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

Yöntemler

get

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