Classes
BadRequest
Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
Protobuf type google.rpc.BadRequest
BadRequest.Builder
Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
Protobuf type google.rpc.BadRequest
BadRequest.FieldViolation
A message type used to describe a single bad request field.
Protobuf type google.rpc.BadRequest.FieldViolation
BadRequest.FieldViolation.Builder
A message type used to describe a single bad request field.
Protobuf type google.rpc.BadRequest.FieldViolation
CodeProto
DebugInfo
Describes additional debugging info.
Protobuf type google.rpc.DebugInfo
DebugInfo.Builder
Describes additional debugging info.
Protobuf type google.rpc.DebugInfo
ErrorDetailsProto
ErrorInfo
Describes the cause of the error with structured details.
Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
{ "reason": "API_DISABLED"
"domain": "googleapis.com"
"metadata": {
"resource": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates that the pubsub.googleapis.com API is not enabled.
Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
{ "reason": "STOCKOUT"
"domain": "spanner.googleapis.com",
"metadata": {
"availableRegions": "us-central1,us-east2"
}
}
Protobuf type google.rpc.ErrorInfo
ErrorInfo.Builder
Describes the cause of the error with structured details.
Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:
{ "reason": "API_DISABLED"
"domain": "googleapis.com"
"metadata": {
"resource": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates that the pubsub.googleapis.com API is not enabled.
Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:
{ "reason": "STOCKOUT"
"domain": "spanner.googleapis.com",
"metadata": {
"availableRegions": "us-central1,us-east2"
}
}
Protobuf type google.rpc.ErrorInfo
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.
Protobuf type google.rpc.Help
Help.Builder
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.
Protobuf type google.rpc.Help
Help.Link
Describes a URL link.
Protobuf type google.rpc.Help.Link
Help.Link.Builder
Describes a URL link.
Protobuf type google.rpc.Help.Link
LocalizedMessage
Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
Protobuf type google.rpc.LocalizedMessage
LocalizedMessage.Builder
Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
Protobuf type google.rpc.LocalizedMessage
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.
Protobuf type google.rpc.PreconditionFailure
PreconditionFailure.Builder
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.
Protobuf type google.rpc.PreconditionFailure
PreconditionFailure.Violation
A message type used to describe a single precondition failure.
Protobuf type google.rpc.PreconditionFailure.Violation
PreconditionFailure.Violation.Builder
A message type used to describe a single precondition failure.
Protobuf type google.rpc.PreconditionFailure.Violation
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.
Protobuf type google.rpc.QuotaFailure
QuotaFailure.Builder
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.
Protobuf type google.rpc.QuotaFailure
QuotaFailure.Violation
A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
Protobuf type google.rpc.QuotaFailure.Violation
QuotaFailure.Violation.Builder
A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
Protobuf type google.rpc.QuotaFailure.Violation
RequestInfo
Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
Protobuf type google.rpc.RequestInfo
RequestInfo.Builder
Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
Protobuf type google.rpc.RequestInfo
ResourceInfo
Describes the resource that is being accessed.
Protobuf type google.rpc.ResourceInfo
ResourceInfo.Builder
Describes the resource that is being accessed.
Protobuf type google.rpc.ResourceInfo
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.
Protobuf type google.rpc.RetryInfo
RetryInfo.Builder
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.
Protobuf type google.rpc.RetryInfo
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.
Protobuf type google.rpc.Status
Status.Builder
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.
Protobuf type google.rpc.Status
StatusProto
Interfaces
BadRequest.FieldViolationOrBuilder
BadRequestOrBuilder
DebugInfoOrBuilder
ErrorInfoOrBuilder
Help.LinkOrBuilder
HelpOrBuilder
LocalizedMessageOrBuilder
PreconditionFailure.ViolationOrBuilder
PreconditionFailureOrBuilder
QuotaFailure.ViolationOrBuilder
QuotaFailureOrBuilder
RequestInfoOrBuilder
ResourceInfoOrBuilder
RetryInfoOrBuilder
StatusOrBuilder
Enums
Code
The canonical error codes for gRPC APIs.
Sometimes multiple error codes may apply. Services should return
the most specific error code that applies. For example, prefer
OUT_OF_RANGE over FAILED_PRECONDITION if both codes apply.
Similarly prefer NOT_FOUND or ALREADY_EXISTS over FAILED_PRECONDITION.
Protobuf enum google.rpc.Code