شرح میدهد که چه پیششرطهایی شکست خوردهاند.
برای مثال، اگر یک RPC به دلیل نیاز به تأیید شرایط خدمات با شکست مواجه شود، میتواند نقض شرایط خدمات را در پیام PreconditionFailure فهرست کند.
| نمایش JSON |
|---|
{
"violations": [
{
object ( |
| فیلدها | |
|---|---|
violations[] | تمام موارد نقض پیششرط را شرح میدهد. |
تخلف
نوعی پیام که برای توصیف یک خطای پیششرط واحد استفاده میشود.
| نمایش JSON |
|---|
{ "type": string, "subject": string, "description": string } |
| فیلدها | |
|---|---|
type | نوع PreconditionFailure. توصیه میکنیم از یک نوع شمارشی مختص سرویس برای تعریف موضوعات نقض پیششرط پشتیبانیشده استفاده کنید. برای مثال، "TOS" برای "نقض شرایط خدمات". |
subject | موضوع، نسبت به نوع ناموفق. برای مثال، "google.com/cloud" نسبت به نوع "TOS" نشان میدهد که به کدام شرایط خدمات ارجاع داده شده است. |
description | توضیحی در مورد چگونگی شکست پیششرط. توسعهدهندگان میتوانند از این توضیح برای درک چگونگی رفع شکست استفاده کنند. برای مثال: «شرایط خدمات پذیرفته نشده است». |