Operation
Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.
Representasi JSON |
{
"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 .
} |
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/{unique_id} .
|
metadata |
object
Metadata khusus layanan yang terkait dengan operasi. Biasanya berisi informasi kemajuan dan metadata umum seperti waktu pembuatan. Beberapa layanan mungkin tidak menyediakan metadata tersebut. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan tipe metadata, jika ada. Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
done |
boolean
Jika nilainya adalah false , berarti operasi masih berlangsung. Jika true , operasi selesai, dan error atau response tersedia.
|
Kolom union result . Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false , error atau response tidak ditetapkan. Jika done == true , tepat satu dari error atau response dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari berikut: |
error |
object (Status )
Hasil error operasi jika terjadi kegagalan atau pembatalan.
|
response |
object
Respons operasi yang normal dan berhasil. 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 . Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-09-10 UTC.
[null,null,["Terakhir diperbarui pada 2024-09-10 UTC."],[[["This resource describes the JSON representation of a long-running operation initiated by a network API call."],["The representation includes fields for operation name (`name`), metadata (`metadata`), completion status (`done`), and result (`result`)."],["The `result` field provides either an error (`error`) or a response (`response`) based on the operation outcome."],["While the operation is in progress, `done` is `false` and neither `error` nor `response` are set; upon completion, `done` becomes `true` and either `error` or `response` is populated."]]],[]]