Code
class Code
The canonical error codes for Google 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
Constants
OK |
Not an error; returned on success HTTP Mapping: 200 OK Generated from protobuf enum |
CANCELLED |
The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request Generated from protobuf enum |
UNKNOWN |
Unknown error. For example, this error may be returned when
a HTTP Mapping: 500 Internal Server Error Generated from protobuf enum |
INVALID_ARGUMENT |
The client specified an invalid argument. Note that this differs
from HTTP Mapping: 400 Bad Request Generated from protobuf enum |
DEADLINE_EXCEEDED |
The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout Generated from protobuf enum |
NOT_FOUND |
Some requested entity (e.g., file or directory) was not found. For privacy reasons, this code may be returned when the client does not have the access rights to the entity, though such usage is discouraged. HTTP Mapping: 404 Not Found Generated from protobuf enum |
ALREADY_EXISTS |
The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict Generated from protobuf enum |
PERMISSION_DENIED |
The caller does not have permission to execute the specified
operation. HTTP Mapping: 403 Forbidden Generated from protobuf enum |
UNAUTHENTICATED |
The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized Generated from protobuf enum |
RESOURCE_EXHAUSTED |
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests Generated from protobuf enum |
FAILED_PRECONDITION |
The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide
between Generated from protobuf enum |
ABORTED |
The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between Generated from protobuf enum |
OUT_OF_RANGE |
The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike Generated from protobuf enum |
UNIMPLEMENTED |
The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented Generated from protobuf enum |
INTERNAL |
Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error Generated from protobuf enum |
UNAVAILABLE |
The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. See the guidelines above for deciding between Generated from protobuf enum |
DATA_LOSS |
Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error Generated from protobuf enum |