- 1.41.0 (latest)
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.2
- 1.18.0
- 1.17.0
- 1.16.1
- 1.15.0
- 1.14.1
- 1.13.0
- 1.12.1
- 1.11.0
- 1.10.1
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.1
- 1.5.2
- 1.4.0
- 1.3.2
- 1.2.0
- 1.1.0
- 1.0.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.2
- 0.3.0
- 0.2.1
- 0.1.0
Status
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
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>
. 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 <https://cloud.google.com/apis/design/errors>
.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes
Name
Description
code
int
The status code, which should be an enum value of google.rpc.Code. This field is a member of
oneof
_ _code
.details
MutableSequence[google.protobuf.any_pb2.Any]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message
str
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. This field is a member of
oneof
_ _message
.