class ClientException : Throwable, ClientError (source)
Exception object representing an error that occurred over-the-wire with a Bloombox Cloud API service. When a failure happens, it bubbles up through the underlying RPC machinery, is caught, decoded, and re-thrown as this exception. When invoking RPC methods, catch this exception, and use the embedded 'status' property to react accordingly.
val cause: Throwable?
Underlying exception provided by the gRPC runtime. This is generally just a wrapped Throwable around a gRPC status, which is itself exposed through this class. |
fun message(): String
Error message to return or display. The service's error code is sent for this value. In rare circumstances, the name of the resulting gRPC status may be returned if no specific error status is available. |
|
fun status(): Status
Underlying gRPC status code that resulted from this error. These error codes roughly map to HTTP errors, and can be found in gRPC's docs at https://grpc.io. |
|
fun toString(): String
Return the status name of this error code for its string-ified form. An index of these error codes is available at https://grpc.io. Basically, the name of the status is taken, and any cause-exception message is appended. |