Index
-
BadRequest
(message) -
BadRequest.FieldViolation
(message) -
LocalizedMessage
(message) -
PreconditionFailure
(message) -
PreconditionFailure.Violation
(message) -
Status
(message)
BadRequest
Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
Fields | |
---|---|
field_
|
Describes all violations in a client request. |
FieldViolation
A message type used to describe a single bad request field.
field
string
A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.
Consider the following:
message CreateContactRequest {
message EmailAddress {
enum Type {
TYPE_UNSPECIFIED = 0;
HOME = 1;
WORK = 2;
}
optional string email = 1;
repeated EmailType type = 2;
}
string full_name = 1;
repeated EmailAddress email_addresses = 2;
}
In this example, in proto field
could take one of the following values:
-
full_name
for a violation in thefull_name
value -
email_addresses[1].email
for a violation in theemail
field of the firstemail_addresses
message -
email_addresses[3].type[2]
for a violation in the secondtype
value in the thirdemail_addresses
message.
In JSON, the same values are represented as:
-
fullName
for a violation in thefullName
value -
emailAddresses[1].email
for a violation in theemail
field of the firstemailAddresses
message -
emailAddresses[3].type[2]
for a violation in the secondtype
value in the thirdemailAddresses
message.
description
string
A description of why the request element is bad.
reason
string
The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9]
, which represents UPPER_SNAKE_CASE.
LocalizedMessage
Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
Fields | |
---|---|
locale
|
The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt . Examples are: "en-US", "fr-CH", "es-MX" |
PreconditionFailure
Describes what preconditions have failed.
For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.
Fields | |
---|---|
violations[]
|
Describes all precondition violations. |
Violation
A message type used to describe a single precondition failure.
Fields | |
---|---|
type
|
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". |
subject
|
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. |
description
|
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". |
Status
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC
. Each Status
message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the API Design Guide .
Fields | |
---|---|
code
|
The status code, which should be an enum value of |
details[]
|
A list of messages that carry the error details. There is a common set of message types for APIs to use. |