ListOperationsResponse

Pesan respons untuk Operations.ListOperations.

Representasi JSON
{
  "operations": [
    {
      object (Operation)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Kolom
operations[]

object (Operation)

Daftar operasi yang cocok dengan filter yang ditentukan dalam permintaan.

nextPageToken

string

Daftar standar token halaman berikutnya.

unreachable[]

string

Daftar yang tidak diurutkan. Resource tidak dapat dijangkau. Diisi saat permintaan menetapkan ListOperationsRequest.return_partial_success dan membaca di seluruh koleksi. Misalnya, saat mencoba mencantumkan semua resource di semua lokasi yang didukung.

Operasi

Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.

Representasi JSON
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
Kolom
name

string

Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{uniqueId}.

metadata

object

{

createTime: Waktu saat operasi dibuat.

endTime: Waktu selesainya operasi.

target: Jalur resource yang ditentukan server untuk target operasi.

verb: Nama kata kerja yang dijalankan oleh operasi.

statusDetail: Status operasi yang dapat dibaca manusia, jika ada.

cancelRequested: Mengidentifikasi apakah pengguna telah meminta pembatalan operasi. Operasi yang berhasil dibatalkan memiliki nilai Operation.error dengan google.rpc.Status.code 1, yang sesuai dengan Code.CANCELLED.

apiVersion: Versi API yang digunakan untuk memulai operasi.

}

done

boolean

Jika nilainya adalah false, artinya operasi masih berlangsung. Jika true, artinya operasi sudah selesai, dan error atau response tersedia.

Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
error

object (Status)

Hasil error operasi jika terjadi kegagalan atau pembatalan.

response

object

Respons normal dan berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.

Akhir kolom yang saling eksklusif.

Status

Jenis Status menentukan model error logis yang cocok untuk berbagai lingkungan pemrograman, meliputi REST API dan RPC API. Jenis error ini digunakan oleh gRPC. Setiap pesan Status berisi tiga bagian data: kode error, pesan error, dan detail error.

Anda dapat mencari tahu lebih lanjut tentang model error ini dan cara penanganannya di Panduan Desain API.

Representasi JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Kolom
code

integer

Kode status, harus berupa nilai enum dari google.rpc.Code.

message

string

Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details, atau dilokalkan oleh klien.

details[]

object

Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.