Package google.rpc

Index

BadRequest

Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

Fields
field_violations[]

FieldViolation

Describes all violations in a client request.

FieldViolation

A message type used to describe a single bad request field.

Fields
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 the full_name value
  • email_addresses[1].email for a violation in the email field of the first email_addresses message
  • email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.

In JSON, the same values are represented as:

  • fullName for a violation in the fullName value
  • emailAddresses[1].email for a violation in the email field of the first emailAddresses message
  • emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
description

string

A description of why the request element is bad.

Help

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Fields

LocalizedMessage

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

Fields
locale

string

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"
message

string

The localized error message in the above locale.

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[]

Violation

Describes all precondition violations.

Violation

A message type used to describe a single precondition failure.

Fields
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".
subject

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.
description

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".

QuotaFailure

Describes how a quota check failed.

For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.

Also see RetryInfo and Help types for other details about handling a quota failure.

Fields
violations[]

Violation

Describes all quota violations.

Violation

A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.

Fields
subject

string

The subject on which the quota check failed. For example, "clientip:" or "project:".
description

string

A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.

For example: "Service disabled" or "Daily Limit for read operations exceeded".

RequestInfo

Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.

Fields
request_id

string

An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
serving_data

string

Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.

ResourceInfo

Describes the resource that is being accessed.

Fields
resource_type

string

A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
resource_name

string

The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is google.rpc.Code.PERMISSION_DENIED.
owner

string

The owner of the resource (optional). For example, "user:" or "project:".
description

string

Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the writer permission on the developer console project.

RetryInfo

Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.

It's always recommended that clients should use exponential backoff when retrying.

Clients should wait until retry_delay amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on retry_delay, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.

Fields
retry_delay

Duration

Clients should wait at least this long between retrying the same request.

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

int32

The status code, which should be an enum value of google.rpc.Code.
message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
details[]

Any

A list of messages that carry the error details. There is a common set of message types for APIs to use.