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. Each Status
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.
Value parameters
- code
-
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- details
-
A list of messages that carry the error details. There is a common set of message types for APIs to use.
- 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.
Attributes
- Companion
- object
- Source
- Status.scala
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Attributes
- Source
- Status.scala
Attributes
- Source
- Status.scala
Attributes
- Source
- Status.scala
Attributes
- Source
- Status.scala
Attributes
- Source
- Status.scala
Attributes
- Source
- Status.scala
Attributes
- Definition Classes
-
GeneratedMessage
- Source
- Status.scala
Returns a human-readable ASCII format representation of this message.
Returns a human-readable ASCII format representation of this message.
The original message can be decoded from this format by using fromAscii on the companion object.
Attributes
- Returns
-
human-readable representation of this message.
- Source
- Status.scala
Attributes
- Source
- Status.scala
Attributes
- Source
- Status.scala
Attributes
- Source
- Status.scala
Attributes
- Source
- Status.scala
Serializes the message into the given coded output stream
Inherited methods
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Serializes the message and returns a byte array containing its raw bytes
Serializes the message and returns a byte array containing its raw bytes
Attributes
- Inherited from:
- GeneratedMessage
- Source
- GeneratedMessageCompanion.scala
Serializes the message and returns a ByteString containing its raw bytes
Serializes the message and returns a ByteString containing its raw bytes
Attributes
- Inherited from:
- GeneratedMessage
- Source
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessage
- Source
- GeneratedMessageCompanion.scala
Attributes
- Inherited from:
- GeneratedMessage
- Source
- GeneratedMessageCompanion.scala
Serializes the message into the given output stream
Serializes the message into the given output stream
Attributes
- Inherited from:
- GeneratedMessage
- Source
- GeneratedMessageCompanion.scala