Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

PreconditionFailureViolation

Type: object

A message type used to describe a single precondition failure.
description

Type: string

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

All schema constraints and annotations
{
  "description": "A description of how the precondition failed. Developers can use this\ndescription to understand how to fix the failure.\n\nFor example: \"Terms of service not accepted\".",
  "type": "string"
}
subject

Type: string

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.
All schema constraints and annotations
{
  "description": "The subject, relative to the type, that failed.\nFor example, \"google.com/cloud\" relative to the \"TOS\" type would indicate\nwhich terms of service is being referenced.",
  "type": "string"
}
type

Type: string

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".
All schema constraints and annotations
{
  "description": "The type of PreconditionFailure. We recommend using a service-specific\nenum type to define the supported precondition violation subjects. For\nexample, \"TOS\" for \"Terms of Service violation\".",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "A message type used to describe a single precondition failure.",
  "properties": {
    "description": {
      "description": "A description of how the precondition failed. Developers can use this\ndescription to understand how to fix the failure.\n\nFor example: \"Terms of service not accepted\".",
      "type": "string"
    },
    "subject": {
      "description": "The subject, relative to the type, that failed.\nFor example, \"google.com/cloud\" relative to the \"TOS\" type would indicate\nwhich terms of service is being referenced.",
      "type": "string"
    },
    "type": {
      "description": "The type of PreconditionFailure. We recommend using a service-specific\nenum type to define the supported precondition violation subjects. For\nexample, \"TOS\" for \"Terms of Service violation\".",
      "type": "string"
    }
  },
  "title": "Violation",
  "type": "object"
}