Files
peernet/demo_server/demo_client/docs/Status.md
2024-04-06 20:45:15 -07:00

1.7 KiB

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.

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] A list of messages that carry the error details. There is a common set of message types for APIs to use. [optional]

Example

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] [Back to API list] [Back to README]