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-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-19 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eStatus\u003c/code\u003e type defines a logical error model used by gRPC for REST and RPC APIs, containing an error code, message, and details.\u003c/p\u003e\n"],["\u003cp\u003eIt includes fields for code (\u003ccode\u003eint32\u003c/code\u003e), message (\u003ccode\u003estring\u003c/code\u003e), and details (\u003ccode\u003egoogle.protobuf.Any\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can learn more about this model and its usage in the API Design Guide.\u003c/p\u003e\n"]]],["The `Status` message, used in REST and RPC APIs like gRPC, defines an error model. It consists of three components: `code` (an enum value), `message` (a developer-facing English error description), and `details` (a list of messages for detailed error information). The `code` field indicates the specific error, while `message` provides a general error description. The `details` field is used for a list of specific data regarding the error.\n"],null,["# Package google.rpc\n\nIndex\n-----\n\n- [Status](/video-creative-ingest/rpc/google.rpc#google.rpc.Status) (message)\n\nStatus\n------\n\nThe `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). Each `Status` message contains three pieces of data: error code, error message, and error details.\n\nYou 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).\n\n| Fields ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `code` | `int32` The status code, which should be an enum value of `google.rpc.Code`. |\n| `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](/video-creative-ingest/rpc/google.rpc#google.rpc.Status.FIELDS.repeated.google.protobuf.Any.google.rpc.Status.details) field, or localized by the client. |\n| `details[]` | [Any](https://protobuf.dev/reference/protobuf/google.protobuf/#any) A list of messages that carry the error details. There is a common set of message types for APIs to use. |"]]