Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Data Transfer
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Подготовка к трансферу
    • Эндпоинты
      • Управление эндпоинтами
      • Параметры эндпоинтов для источников
        • Apache Kafka®
        • ClickHouse
        • Greenplum®
        • MongoDB
        • MySQL
        • Oracle
        • PostgreSQL
        • Yandex Data Streams
      • Параметры эндпоинтов для приемников
        • ClickHouse
        • Greenplum®
        • MongoDB
        • MySQL
        • Object Storage
        • PostgreSQL
        • YDB
    • Управление трансфером
    • Работа с базами данных во время трансфера
    • Мониторинг состояния трансфера
  • Практические руководства
    • Все руководства
    • Миграция базы данных в Yandex Managed Service for MongoDB
    • Миграция базы данных в Yandex Managed Service for MySQL
    • Миграция базы данных из Yandex Managed Service for MySQL в MySQL
    • Миграция базы данных в Yandex Managed Service for PostgreSQL
    • Перенос данных из PostgreSQL в ClickHouse
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Сеть в Yandex Data Transfer
    • Какие задачи решает сервис
    • Жизненный цикл трансфера
    • Квоты и лимиты
  • Решение проблем
    • Обзор
    • MongoDB
    • MySQL
    • PostgreSQL
    • Yandex Managed Service for YDB и Yandex Data Streams
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • EndpointService
      • TransferService
      • OperationService
    • REST (англ.)
      • Overview
      • Endpoint
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • Transfer
        • Overview
        • activate
        • create
        • deactivate
        • delete
        • get
        • list
        • update
  • Вопросы и ответы
  1. Справочник API
  2. gRPC (англ.)
  3. OperationService

OperationService

Статья создана
Yandex.Cloud
  • Calls OperationService
  • Get
    • GetOperationRequest
    • Operation
  • Cancel
    • CancelOperationRequest
    • Operation

A set of methods for managing operations for asynchronous API requests.

Call Description
Get Returns the specified Operation resource.
Cancel Cancels the specified operation.

Calls OperationService

Get

Returns the specified Operation resource.

rpc Get (GetOperationRequest) returns (Operation)

GetOperationRequest

Field Description
operation_id string
Required. ID of the Operation resource to return.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Cancel

Cancels the specified operation.
Note that currently Yandex Object Storage API does not support cancelling operations.

rpc Cancel (CancelOperationRequest) returns (Operation)

CancelOperationRequest

Field Description
operation_id string
Required. ID of the operation to cancel.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Была ли статья полезна?

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • Calls OperationService
  • Get
  • GetOperationRequest
  • Operation
  • Cancel
  • CancelOperationRequest
  • Operation