Package google.rpc
Stay organized with collections
Save and categorize content based on your preferences.
Status
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.
| Fields |
code |
int32
The status code, which should be an enum value of google.rpc.Code.
|
message |
string
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 field, or localized by the client.
|
details[] |
Any
A list of messages that carry the error details. There is a common set of message types for APIs to use.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["The `Status` type defines a logical error model suitable for various programming environments, including REST and RPC APIs."],["Each `Status` message includes an error code, an error message, and error details."],["The `code` field represents the status code, which should be an enum value of `google.rpc.Code`."],["The `message` field is a developer-facing error message in English, while user-facing messages should be localized."],["The `details` field is a list of messages carrying error details, using common message types."]]],[]]
