package rpc
- Alphabetic
- Public
- Protected
Type Members
- sealed abstract class Code extends GeneratedEnum
The canonical error codes for gRPC APIs.
The canonical error codes for gRPC APIs.
Sometimes multiple error codes may apply. Services should return the most specific error code that applies. For example, prefer
OUT_OF_RANGE
overFAILED_PRECONDITION
if both codes apply. Similarly preferNOT_FOUND
orALREADY_EXISTS
overFAILED_PRECONDITION
. - final case class Status(code: Code = com.google.rpc.Code.OK, message: String = "", details: Option[Any] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Status] with Product with Serializable
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). EachStatus
message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
- code
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- message
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- details
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Annotations
- @SerialVersionUID()