Package google.longrunning

Индекс

Операции

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

Если выполнение метода API обычно занимает много времени, можно реализовать его так, чтобы он возвращал клиенту Operation . Клиент может использовать этот интерфейс для асинхронного получения реального ответа, опрашивая ресурс Operation, или передать ресурс 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
WaitOperation

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

Ожидает завершения указанной длительной операции или достижения заданного тайм-аута, возвращая последнее состояние. Если операция уже выполнена, немедленно возвращается последнее состояние. Если указанное время ожидания превышает тайм-аут HTTP/RPC по умолчанию, используется тайм-аут HTTP/RPC. Если сервер не поддерживает этот метод, он возвращает google.rpc.Code.UNIMPLEMENTED . Обратите внимание, что этот метод работает по принципу «лучшего из возможных». Он может вернуть последнее состояние до истечения указанного тайм-аута (в том числе немедленно), то есть даже немедленный ответ не гарантирует завершения операции.

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

CancelOperationRequest

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

Поля
name

string

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

DeleteOperationRequest

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

Поля
name

string

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

GetOperationRequest

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

Поля
name

string

Имя ресурса операции.

ListOperationsRequest

Сообщение-запрос для 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 .

WaitOperationRequest

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

Поля
name

string

Имя ресурса операции, которого необходимо ожидать.

timeout

Duration

Максимальная продолжительность ожидания до истечения времени ожидания. Если оставить пустым, время ожидания не будет превышать время, разрешенное базовым протоколом HTTP/RPC. Если также указан крайний срок контекста RPC, будет использоваться более короткий срок.