Package google.longrunning

Индекс

Операции

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

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

Отменить операцию

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

(В настоящее время не поддерживается) Запускает асинхронную отмену длительной операции.

Области полномочий

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

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

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

(В настоящее время не поддерживается) Удаляет длительную операцию.

Области полномочий

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

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

rpc GetOperation( GetOperationRequest ) returns ( Operation )

Получает актуальное состояние длительной операции. Клиенты могут использовать этот метод для периодического опроса результата операции в соответствии с рекомендациями API-сервиса.

Области полномочий

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

  • https://www.googleapis.com/auth/cloud-platform
Разрешения IAM

Для доступа к ресурсу name требуются следующие разрешения IAM :

  • routeoptimization.operations.get

Для получения более подробной информации см. документацию IAM .

ListOperations

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

(В настоящее время не поддерживается) Отображает список операций, соответствующих указанному фильтру в запросе.

Области полномочий

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

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

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

(В настоящее время не поддерживается) Ожидает завершения указанной длительной операции или истечения указанного времени ожидания, возвращая последнее состояние.

Области полномочий

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

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

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

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

Стандартный токен страницы списка.

return_partial_success

bool

Если установлено значение true , то достижимые операции возвращаются как обычно, а недостижимые — в поле ListOperationsResponse.unreachable .

Это может быть true только при чтении данных из разных коллекций. Например, когда parent установлен на "projects/example/locations/-" .

Это поле не поддерживается по умолчанию и приведет к ошибке UNIMPLEMENTED , если оно задано, если иное явно не указано в документации к конкретной услуге или продукту.

ListOperationsResponse

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

Поля
operations[]

Operation

Список операций, соответствующих указанному в запросе фильтру.

next_page_token

string

Стандартный токен для перехода на следующую страницу списка.

unreachable[]

string

Неупорядоченный список. Недоступные ресурсы. Заполняется, когда запрос устанавливает ListOperationsRequest.return_partial_success и считывает данные из разных коллекций. Например, при попытке перечислить все ресурсы во всех поддерживаемых местоположениях.

Операция

Этот ресурс представляет собой длительную операцию, являющуюся результатом вызова сетевого 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, будет использоваться более короткое значение.