Ресурс: Операция
Этот ресурс представляет длительную операцию, являющуюся результатом вызова сетевого API.
Представление JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Поля | |
---|---|
name | Назначаемое сервером имя, уникальное только в пределах той же службы, которая его первоначально вернула. Если вы используете сопоставление HTTP по умолчанию, |
metadata | Это поле будет содержать объект Объект, содержащий поля произвольного типа. Дополнительное поле |
done | Если значение равно |
result поля объединения. Результат операции, который может быть как error , так и допустимым response . Если done == false , ни error , ни response не устанавливаются. Если done == true , может быть установлена только одна error или response . Некоторые сервисы могут не дать результата. result может быть только одним из следующих: | |
error | Это поле всегда не будет установлено, если операция создана с помощью |
response | Это поле будет содержать объект Объект, содержащий поля произвольного типа. Дополнительное поле |
Положение дел
Тип Status
определяет модель логической ошибки, подходящую для различных сред программирования, включая REST API и RPC API. Он используется gRPC . Каждое сообщение Status
содержит три элемента данных: код ошибки, сообщение об ошибке и сведения об ошибке.
Узнать больше об этой модели ошибок и о том, как с ней работать, можно в Руководстве по дизайну API .
Представление JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Поля | |
---|---|
code | Код состояния, который должен быть перечислимым значением |
message | Сообщение об ошибке для разработчика, которое должно быть на английском языке. Любое сообщение об ошибке, с которым сталкивается пользователь, должно быть локализовано и отправлено в поле |
details[] | Список сообщений, содержащих сведения об ошибке. Существует общий набор типов сообщений для использования API. Объект, содержащий поля произвольного типа. Дополнительное поле |
Методы | |
---|---|
| Получает последнее состояние длительной операции. |