Package google.longrunning

Индекс

• Operations (интерфейс)
• CancelOperationRequest (сообщение)
• DeleteOperationRequest (сообщение)
• GetOperationRequest (сообщение)
• ListOperationsRequest (сообщение)
• ListOperationsResponse (сообщение)
• Operation (сообщение)
• WaitOperationRequest (сообщение)

Операции

Управляет длительными операциями с помощью службы API.

Когда выполнение метода API обычно занимает много времени, его можно спроектировать так, чтобы возвращать Operation клиенту, и клиент может использовать этот интерфейс для асинхронного получения реального ответа путем опроса ресурса операции или передачи ресурса операции другому API ( например Pub/Sub API) для получения ответа. Любая служба API, возвращающая длительные операции, должна реализовывать интерфейс Operations , чтобы разработчики могли иметь единообразный клиентский интерфейс.

ОтменаОперации

rpc CancelOperation( CancelOperationRequest ) returns ( Empty ) Запускает асинхронную отмену длительной операции. Сервер делает все возможное, чтобы отменить операцию, но успех не гарантирован. Если сервер не поддерживает этот метод, он возвращает google.rpc.Code.UNIMPLEMENTED . Клиенты могут использовать Operations.GetOperation или другие методы, чтобы проверить, была ли отмена успешной или завершилась ли операция, несмотря на отмену. При успешной отмене операция не удаляется; вместо этого она становится операцией со значением Operation.error и google.rpc.Status.code , равным 1, что соответствует Code.CANCELLED . Области авторизации Требуется следующая область действия OAuth: https://www.googleapis.com/auth/cloud-platform

УдалитьОперацию

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty ) Удаляет длительную операцию. Этот метод указывает на то, что клиент больше не заинтересован в результате операции. Это не отменяет операцию. Если сервер не поддерживает этот метод, он возвращает google.rpc.Code.UNIMPLEMENTED . Области авторизации Требуется следующая область действия OAuth: https://www.googleapis.com/auth/cloud-platform

GetOperation

rpc GetOperation( GetOperationRequest ) returns ( Operation ) Получает последнее состояние длительной операции. Клиенты могут использовать этот метод для опроса результатов операции через определенные промежутки времени, рекомендованные службой API. Области авторизации Требуется следующая область действия OAuth: https://www.googleapis.com/auth/cloud-platform IAM-разрешения Требуется следующее разрешение IAM для ресурса name : routeoptimization.operations.get Дополнительную информацию см. в документации IAM .

Список операций
rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse ) Перечисляет операции, соответствующие указанному фильтру в запросе. Если сервер не поддерживает этот метод, он возвращает UNIMPLEMENTED . Области авторизации Требуется следующая область действия OAuth: https://www.googleapis.com/auth/cloud-platform

Ожидание операции

rpc WaitOperation( WaitOperationRequest ) returns ( Operation ) Ожидает, пока указанная длительная операция не будет завершена или не достигнет заданного времени ожидания, возвращая последнее состояние. Если операция уже выполнена, немедленно возвращается последнее состояние. Если указанное время ожидания больше, чем время ожидания HTTP/RPC по умолчанию, используется время ожидания HTTP/RPC. Если сервер не поддерживает этот метод, он возвращает google.rpc.Code.UNIMPLEMENTED . Обратите внимание, что этот метод основан на принципе максимальных усилий. Он может вернуть последнее состояние до указанного таймаута (в том числе немедленно), то есть даже немедленный ответ не является гарантией выполнения операции. Области авторизации Требуется следующая область действия OAuth: https://www.googleapis.com/auth/cloud-platform

ОтменаЗапросОперации

Сообщение запроса для Operations.CancelOperation .

Поля
name	string Имя ресурса операции, которую необходимо отменить.

Удалить запрос операции

Сообщение запроса для Operations.DeleteOperation .

Поля
name	string Имя ресурса операции, который необходимо удалить.

Получить запрос операции

Сообщение запроса для Operations.GetOperation .

Поля
name	string Имя ресурса операции.

Запрос списка операций

Сообщение запроса для Operations.ListOperations .

Поля
name	string Имя родительского ресурса операции.
filter	string Стандартный фильтр списка.
page_size	int32 Стандартный размер страницы списка.
page_token	string Стандартный токен страницы списка.

ListOperationsResponse

Ответное сообщение для Operations.ListOperations .

Поля
operations[]	Operation Список операций, соответствующих указанному фильтру в запросе.
next_page_token	string Стандартный токен следующей страницы списка.

Операция

Этот ресурс представляет собой длительную операцию, являющуюся результатом вызова сетевого API.

Поля
name	string Имя, назначенное сервером, уникальное только в пределах той службы, которая его первоначально возвращает. Если вы используете сопоставление HTTP по умолчанию, name должно быть именем ресурса, заканчивающимся на operations/{unique_id} .
metadata	Any Метаданные, относящиеся к службе, связанные с операцией. Обычно он содержит информацию о ходе выполнения и общие метаданные, такие как время создания. Некоторые службы могут не предоставлять такие метаданные. Любой метод, возвращающий длительную операцию, должен документировать тип метаданных, если таковые имеются.
done	bool Если значение false , это означает, что операция все еще выполняется. Если true , операция завершается и доступна либо error , либо response .
result поля объединения. Результат операции, который может быть либо error , либо допустимым response . Если done == false , ни error , ни response не устанавливаются. Если done == true , можно установить ровно одну error или response . Некоторые службы могут не предоставить результат. result может быть только одним из следующих:
error	Status Ошибка результата операции в случае сбоя или отмены.
response	Any Нормальный, успешный ответ на операцию. Если исходный метод не возвращает данных об успехе, например, Delete , ответом будет google.protobuf.Empty . Если исходный метод — стандартный Get / Create / Update , ответом должен быть ресурс. Для других методов ответ должен иметь тип XxxResponse , где Xxx — исходное имя метода. Например, если исходное имя метода — TakeSnapshot() , предполагаемый тип ответа — TakeSnapshotResponse .

ОжиданиеОперацииЗапрос

Сообщение запроса для Operations.WaitOperation .

Поля
name	string Имя ресурса операции для ожидания.
timeout	Duration Максимальная продолжительность ожидания до истечения времени ожидания. Если оставить это поле пустым, время ожидания будет максимально разрешено базовым протоколом HTTP/RPC. Если также указан крайний срок контекста RPC, будет использоваться более короткий срок.