object RPCStatus
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.
- Alphabetic
- By Inheritance
- RPCStatus
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def all: Seq[RPCStatus]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromGrpcStatusCode(grpcStatusCode: Int): RPCStatus
- def fromHttpStatus(httpStatus: HttpStatus): RPCStatus
Mapping HttpStatus to RPCStatus.
Mapping HttpStatus to RPCStatus. This is useful when mapping third-party API statuses into RPCStatus
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def ofCode(code: Int): RPCStatus
- def ofCodeName(name: String): RPCStatus
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unapply(v: Value): Option[RPCStatus]
- def unapply(s: String): Option[RPCStatus]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- case object ABORTED_U12 extends RPCStatus with Product with Serializable
The request is aborted (e.g., dead-lock, transaction conflicts, etc.) The client should retry the request at a higher-level.
- case object ALREADY_EXISTS_U6 extends RPCStatus with Product with Serializable
The resource creation request failed because it already exists.
- case object CANCELLED_U11 extends RPCStatus with Product with Serializable
The request was cancelled, typically by the client.
The request was cancelled, typically by the client. The client should not retry the request unless it's a network issue.
- case object DATA_LOSS_I8 extends RPCStatus with Product with Serializable
Data loss or corrupted data
- case object DEADLINE_EXCEEDED_I4 extends RPCStatus with Product with Serializable
The request cannot be processed in the user-specified deadline.
The request cannot be processed in the user-specified deadline. The client may retry the request
- case object EXCEEDED_BUDGET_R8 extends RPCStatus with Product with Serializable
The user has exhausted the budget for processing the request.
- case object EXCEEDED_CPU_LIMIT_R3 extends RPCStatus with Product with Serializable
The user has reached its CPU usage limit
- case object EXCEEDED_DATA_SIZE_LIMIT_R6 extends RPCStatus with Product with Serializable
The user has reached its data size limit
- case object EXCEEDED_MEMORY_LIMIT_R4 extends RPCStatus with Product with Serializable
The user has reached its memory usage limit
- case object EXCEEDED_RATE_LIMIT_R2 extends RPCStatus with Product with Serializable
There are too many requests.
There are too many requests. The user needs to retry the request after a while
- case object EXCEEDED_STORAGE_LIMIT_R7 extends RPCStatus with Product with Serializable
The user has reached its storage size limit
- case object EXCEEDED_TIME_LIMIT_R5 extends RPCStatus with Product with Serializable
The user has reached its running time limit
- case object INCONSISTENT_STATE_U10 extends RPCStatus with Product with Serializable
The service or the use has an inconsistent state and cannot fulfill the request.
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.
- case object INTERNAL_ERROR_I0 extends RPCStatus with Product with Serializable
Internal failures where the user can retry the request in general
- case object INTERRUPTED_I5 extends RPCStatus with Product with Serializable
The request is interrupted at the service
- case object INVALID_ARGUMENT_U2 extends RPCStatus with Product with Serializable
RPC request arguments have invalid values
- case object INVALID_REQUEST_U1 extends RPCStatus with Product with Serializable
Invalid RPC request.
Invalid RPC request. The user should not retry the request in general.
- case object NOT_FOUND_U5 extends RPCStatus with Product with Serializable
The requested resource or RPC method is not found
- case object NOT_SUPPORTED_U7 extends RPCStatus with Product with Serializable
The requested RPC method is not supported.
- case object OUT_OF_MEMORY_R1 extends RPCStatus with Product with Serializable
The service is experiencing insufficient memory
- case object OUT_OF_RANGE_U4 extends RPCStatus with Product with Serializable
Invalid range data is given to an RPC request argument.
- case object PERMISSION_DENIED_U14 extends RPCStatus with Product with Serializable
The user does not have a permission to access the resource
- case object RESOURCE_EXHAUSTED_R0 extends RPCStatus with Product with Serializable
The resource for completing the request is insufficient.
- case object SERVICE_SHUTTING_DOWN_I7 extends RPCStatus with Product with Serializable
The service is shutting down now.
- case object SERVICE_STARTING_UP_I6 extends RPCStatus with Product with Serializable
The service is starting now.
The service is starting now. The client can retry the request after a while
- case object SUCCESS_S0 extends RPCStatus with Product with Serializable
- case object SYNTAX_ERROR_U3 extends RPCStatus with Product with Serializable
Syntax error in an RPC argument
- case object TIMEOUT_I3 extends RPCStatus with Product with Serializable
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.
- case object UNAUTHENTICATED_U13 extends RPCStatus with Product with Serializable
The user has not been authenticated
- case object UNAVAILABLE_I2 extends RPCStatus with Product with Serializable
The service is unavailable.
- case object UNEXPECTED_STATE_U9 extends RPCStatus with Product with Serializable
Some precondition to succeed this request is not met (e.g., invalid configuration).
Some precondition to succeed this request is not met (e.g., invalid configuration). The client should not retry the request until fixing the state.
- case object UNIMPLEMENTED_U8 extends RPCStatus with Product with Serializable
The requested RPC method is not implemented.
- case object UNKNOWN_I1 extends RPCStatus with Product with Serializable
An unknown internal error
- case object USER_ERROR_U0 extends RPCStatus with Product with Serializable
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated