TheStatustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used bygRPC. EachStatusmessage 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 theAPI Design Guide.
Fields
code
int32
The status code, which should be an enum value ofgoogle.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 thegoogle.rpc.Status.detailsfield, or localized by the client.
[[["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-04-30 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eStatus\u003c/code\u003e type defines a logical error model suitable for various programming environments, including REST and RPC APIs.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eStatus\u003c/code\u003e message includes three data components: an error code, an error message, and error details.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecode\u003c/code\u003e field within \u003ccode\u003eStatus\u003c/code\u003e is an integer representing the error status.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003emessage\u003c/code\u003e field is a developer-facing English error message, while user-facing messages should be localized.\u003c/p\u003e\n"],["\u003cp\u003eThe details field is a list of messages that contain the details of the error.\u003c/p\u003e\n"]]],[],null,["# Package google.rpc\n\nIndex\n-----\n\n- [Status](/dataflow/docs/reference/data-pipelines/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)."]]
