Namespaces

Google\Rpc\BadRequest Google\Rpc\Help Google\Rpc\PreconditionFailure Google\Rpc\QuotaFailure

Classes

BadRequest

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

BadRequest_FieldViolation ^deprecated

This class is deprecated. Use Google\Rpc\BadRequest\FieldViolation instead.

Code

The canonical error codes for Google APIs.

DebugInfo

Describes additional debugging info.

Help

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

Help_Link ^deprecated

This class is deprecated. Use Google\Rpc\Help\Link instead.

LocalizedMessage

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

PreconditionFailure

Describes what preconditions have failed.

PreconditionFailure_Violation ^deprecated

This class is deprecated. Use Google\Rpc\PreconditionFailure\Violation instead.

QuotaFailure

Describes how a quota check failed.

QuotaFailure_Violation ^deprecated

This class is deprecated. Use Google\Rpc\QuotaFailure\Violation instead.

RequestInfo

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

ResourceInfo

Describes the resource that is being accessed.

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.

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. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs

Overview

The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.