PreconditionFailure

失敗した前提条件について説明します。

たとえば、利用規約の承認が必要であるために RPC が失敗した場合、PreconditionFailure メッセージに利用規約違反が一覧表示される可能性があります。

JSON 表現
{
  "violations": [
    {
      object (Violation)
    }
  ]
}
フィールド
violations[]

object (Violation)

すべての前提条件違反について説明します。

違反

単一の前提条件の失敗を説明するために使用されるメッセージ タイプ。

JSON 表現
{
  "type": string,
  "subject": string,
  "description": string
}
フィールド
type

string

PreconditionFailure のタイプ。サービス固有の列挙型を使用して、サポートされている前提条件違反のサブジェクトを定義することをおすすめします。たとえば、「利用規約違反」の場合は「TOS」となります。

subject

string

失敗したタイプに関連するサブジェクト。たとえば、「TOS」タイプに関する「google.com/cloud」では、どの利用規約を参照しているかが示されます。

description

string

前提条件が失敗した理由の説明。デベロッパーはこの説明を使用して、失敗の修正方法を理解できます。

例: 承認されなかった利用規約。