Mendeskripsikan prasyarat yang gagal.
Misalnya, jika RPC gagal karena memerlukan Persyaratan Layanan untuk disetujui, RPC tersebut dapat mencantumkan pelanggaran persyaratan layanan dalam pesan PreconditionFailure.
| Representasi JSON |
|---|
{
"violations": [
{
object ( |
| Kolom | |
|---|---|
violations[] |
Menjelaskan semua pelanggaran prasyarat. |
Pelanggaran
Jenis pesan yang digunakan untuk mendeskripsikan kegagalan prasyarat tunggal.
| Representasi JSON |
|---|
{ "type": string, "subject": string, "description": string } |
| Kolom | |
|---|---|
type |
Jenis PreconditionFailure. Sebaiknya gunakan jenis enum khusus layanan untuk menentukan subjek pelanggaran prasyarat yang didukung. Misalnya, "TOS" untuk "pelanggaran Persyaratan Layanan". |
subject |
Subjek, relatif terhadap jenis, yang gagal. Misalnya, "google.com/cloud" relatif terhadap jenis "TOS" akan menunjukkan persyaratan layanan mana yang dirujuk. |
description |
Deskripsi tentang penyebab kegagalan prasyarat. Developer dapat menggunakan deskripsi ini untuk memahami cara memperbaiki kegagalan. Misalnya: "Persyaratan layanan belum disetujui". |