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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RPCStatus
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def all: Seq[RPCStatus]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def fromGrpcStatusCode(grpcStatusCode: Int): RPCStatus
  10. def fromHttpStatus(httpStatus: HttpStatus): RPCStatus

    Mapping HttpStatus to RPCStatus.

    Mapping HttpStatus to RPCStatus. This is useful when mapping third-party API statuses into RPCStatus

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def ofCode(code: Int): RPCStatus
  18. def ofCodeName(name: String): RPCStatus
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. def unapply(v: Value): Option[RPCStatus]
  22. def unapply(s: String): Option[RPCStatus]
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. 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.

  27. case object ALREADY_EXISTS_U6 extends RPCStatus with Product with Serializable

    The resource creation request failed because it already exists.

  28. 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.

  29. case object DATA_LOSS_I8 extends RPCStatus with Product with Serializable

    Data loss or corrupted data

  30. 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

  31. case object EXCEEDED_BUDGET_R8 extends RPCStatus with Product with Serializable

    The user has exhausted the budget for processing the request.

  32. case object EXCEEDED_CPU_LIMIT_R3 extends RPCStatus with Product with Serializable

    The user has reached its CPU usage limit

  33. case object EXCEEDED_DATA_SIZE_LIMIT_R6 extends RPCStatus with Product with Serializable

    The user has reached its data size limit

  34. case object EXCEEDED_MEMORY_LIMIT_R4 extends RPCStatus with Product with Serializable

    The user has reached its memory usage limit

  35. 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

  36. case object EXCEEDED_STORAGE_LIMIT_R7 extends RPCStatus with Product with Serializable

    The user has reached its storage size limit

  37. case object EXCEEDED_TIME_LIMIT_R5 extends RPCStatus with Product with Serializable

    The user has reached its running time limit

  38. 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.

  39. case object INTERNAL_ERROR_I0 extends RPCStatus with Product with Serializable

    Internal failures where the user can retry the request in general

  40. case object INTERRUPTED_I5 extends RPCStatus with Product with Serializable

    The request is interrupted at the service

  41. case object INVALID_ARGUMENT_U2 extends RPCStatus with Product with Serializable

    RPC request arguments have invalid values

  42. 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.

  43. case object NOT_FOUND_U5 extends RPCStatus with Product with Serializable

    The requested resource or RPC method is not found

  44. case object NOT_SUPPORTED_U7 extends RPCStatus with Product with Serializable

    The requested RPC method is not supported.

  45. case object OUT_OF_MEMORY_R1 extends RPCStatus with Product with Serializable

    The service is experiencing insufficient memory

  46. case object OUT_OF_RANGE_U4 extends RPCStatus with Product with Serializable

    Invalid range data is given to an RPC request argument.

  47. case object PERMISSION_DENIED_U14 extends RPCStatus with Product with Serializable

    The user does not have a permission to access the resource

  48. case object RESOURCE_EXHAUSTED_R0 extends RPCStatus with Product with Serializable

    The resource for completing the request is insufficient.

  49. case object SERVICE_SHUTTING_DOWN_I7 extends RPCStatus with Product with Serializable

    The service is shutting down now.

  50. 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

  51. case object SUCCESS_S0 extends RPCStatus with Product with Serializable
  52. case object SYNTAX_ERROR_U3 extends RPCStatus with Product with Serializable

    Syntax error in an RPC argument

  53. 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.

  54. case object UNAUTHENTICATED_U13 extends RPCStatus with Product with Serializable

    The user has not been authenticated

  55. case object UNAVAILABLE_I2 extends RPCStatus with Product with Serializable

    The service is unavailable.

  56. 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.

  57. case object UNIMPLEMENTED_U8 extends RPCStatus with Product with Serializable

    The requested RPC method is not implemented.

  58. case object UNKNOWN_I1 extends RPCStatus with Product with Serializable

    An unknown internal error

  59. case object USER_ERROR_U0 extends RPCStatus with Product with Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped