33 lines
1.7 KiB
Markdown
33 lines
1.7 KiB
Markdown
# 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](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).
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**code** | **int** | The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. | [optional]
|
|
**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][google.rpc.Status.details] field, or localized by the client. | [optional]
|
|
**details** | [**List[GoogleProtobufAny]**](GoogleProtobufAny.md) | A list of messages that carry the error details. There is a common set of message types for APIs to use. | [optional]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from openapi_client.models.status import Status
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of Status from a JSON string
|
|
status_instance = Status.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(Status.to_json())
|
|
|
|
# convert the object into a dict
|
|
status_dict = status_instance.to_dict()
|
|
# create an instance of Status from a dict
|
|
status_form_dict = status.from_dict(status_dict)
|
|
```
|
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
|
|
|