Define the standard RPC code that can be used for generic RPC service implementation.
This covers all gRPC statuses and have pre-defined mappings to HTTP status (4xx, 5xx) code.
If you need an application-specific error code, use an additional argument of the RPCError class.
- Companion:
- class
Type members
Classlikes
The request is aborted (e.g., dead-lock, transaction conflicts, etc.) The client should retry the request it a higher-level.
The request is aborted (e.g., dead-lock, transaction conflicts, etc.) The client should retry the request it a higher-level.
The resource creation request failed because it already exists.
The resource creation request failed because it already exists.
The request was cancelled, typically by the client. The client should not retry the request unless it's a network issue.
The request was cancelled, typically by the client. The client should not retry the request unless it's a network issue.
The request cannot be processed in the user-specified deadline. The client may retry the request
The request cannot be processed in the user-specified deadline. The client may retry the request
The user has exhausted the budget for processing the request.
The user has exhausted the budget for processing the request.
The user has reached its CPU usage limit
The user has reached its CPU usage limit
The user has reached its data size limit
The user has reached its data size limit
The user has reached its memory usage limit
The user has reached its memory usage limit
There are too many requests. The user needs to retry the request after a while
There are too many requests. The user needs to retry the request after a while
The user has reached its storage size limit
The user has reached its storage size limit
The user has reached its running time limit
The user has reached its running time limit
The service or the use has an inconsistent state and cannot fulfill the request. The client should not retry the request until fixing the state.
The service or the use has an inconsistent state and cannot fulfill the request. The client should not retry the request until fixing the state.
Internal failures where the user can retry the request in general
Internal failures where the user can retry the request in general
The request is interrupted at the service
The request is interrupted at the service
RPC request arguments have invalid values
RPC request arguments have invalid values
Invalid RPC request. The user should not retry the request in general.
Invalid RPC request. The user should not retry the request in general.
The requested resource or RPC method is not found
The requested resource or RPC method is not found
The requested RPC method is not supported.
The requested RPC method is not supported.
The service is experiencing insufficient memory
The service is experiencing insufficient memory
Invalid range data is given to an RPC request argument.
Invalid range data is given to an RPC request argument.
The user does not have a permission to access the resource
The user does not have a permission to access the resource
The resource for completing the request is insufficient.
The resource for completing the request is insufficient.
The service is shutting down now.
The service is shutting down now.
The service is starting now. The client can retry the request after a while
The service is starting now. The client can retry the request after a while
Syntax error in an RPC argument
Syntax error in an RPC argument
The service respond the request in time (e.g., circuit breaker is open, timeout exceeded, etc.) For operations that change the system state, this error might be returned even if the operation has completed successfully.
The service respond the request in time (e.g., circuit breaker is open, timeout exceeded, etc.) For operations that change the system state, this error might be returned even if the operation has completed successfully.
The user has not been authenticated
The user has not been authenticated
Some precondition to succeed this request is not met (e.g., invalid configuration). The client should not retry the request until fixing the state.
Some precondition to succeed this request is not met (e.g., invalid configuration). The client should not retry the request until fixing the state.
The requested RPC method is not implemented.
The requested RPC method is not implemented.