Yandex Cloud
Поиск
Связаться с экспертомПопробовать бесплатно
  • Кейсы
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
  • Marketplace
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Искусственный интеллект
    • Безопасность
    • Инструменты DevOps
    • Бессерверные вычисления
    • Управление ресурсами
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Калькулятор цен
    • Тарифы
    • Акции и free tier
  • Кейсы
  • Документация
  • Блог
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ООО «Яндекс.Облако»
Yandex Audit Trails
  • Начало работы
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
  • Метрики Monitoring
  • Справочник событий уровня конфигурации
  • Справочник событий уровня сервисов
      • ActivateTransfer
      • AddTablesToTransfer
      • CreateEndpoint
      • CreateTransfer
      • DeactivateTransfer
      • DeleteEndpoint
      • DeleteTransfer
      • FreezeTransferVersion
      • PauseTransfer
      • RemoveTablesFromTransfer
      • RestartTransfer
      • ReUploadTransfer
      • StartTransfer
      • TestTransfer
      • UnfreezeTransferVersion
      • UpdateEndpoint
      • UpdateTransfer
      • UpdateTransferVersion
      • UploadTransfer
  • История изменений
  • Обучающие курсы

В этой статье:

  • Event JSON schema
  • Field description
  • IamAuthentication
  • IamTokenInfo
  • Authorization
  • ResourceMetadata
  • Resource
  • RequestMetadata
  • Status
  • TransferEventDetails
  • Transfer
  • Endpoint
  • EndpointSettings
  • MysqlSource
  • MysqlConnection
  • OnPremiseMysql
  • TLSMode
  • TLSConfig
  • ConnectionManagerConnection
  • Secret
  • MysqlObjectTransferSettings
  • PostgresSource
  • PostgresConnection
  • OnPremisePostgres
  • PostgresObjectTransferSettings
  • YdbSource
  • YDSSource
  • Parser
  • GenericParserCommon
  • DataSchema
  • FieldList
  • ColSchema
  • KafkaSource
  • KafkaConnectionOptions
  • OnPremiseKafka
  • KafkaAuth
  • KafkaSaslSecurity
  • DataTransformationOptions
  • MongoSource
  • MongoConnection
  • MongoConnectionOptions
  • OnPremiseMongo
  • MongoConnectionManagerConnection
  • MongoCollection
  • ClickhouseSource
  • ClickhouseConnection
  • ClickhouseConnectionOptions
  • OnPremiseClickhouse
  • ClickhouseShard
  • MysqlTarget
  • PostgresTarget
  • ClickhouseTarget
  • AltName
  • ClickhouseSharding
  • ColumnValueHash
  • ColumnValueMapping
  • ValueToShard
  • ColumnValue
  • YdbTarget
  • KafkaTarget
  • KafkaTargetTopicSettings
  • KafkaTargetTopic
  • Serializer
  • SerializerDebezium
  • DebeziumSerializerParameter
  • MongoTarget
  • MetrikaSource
  • MetrikaStream
  • YDSTarget
  • Runtime
  • YcRuntime
  • ShardingUploadParams
  • RegularSnapshot
  • RegularSnapshotSettings
  • IncrementalTable
  • RetryConfig
  • Transformation
  • Transformer
  • MaskFieldTransformer
  • TablesFilter
  • MaskFunction
  • MaskFunctionHash
  • FilterColumnsTransformer
  • ColumnsFilter
  • RenameTablesTransformer
  • RenameTable
  • Table
  • ReplacePrimaryKeyTransformer
  • ToStringTransformer
  • SharderTransformer
  • TableSplitterTransformer
  • FilterRowsTransformer
  • DataObjects
  1. Справочник аудитных логов (англ.)
  2. datatransfer
  3. ActivateTransfer

Data Transfer Audit Trails Events: ActivateTransfer

Статья создана
Yandex Cloud
Обновлена 23 апреля 2026 г.
  • Event JSON schema
  • Field description
  • IamAuthentication
  • IamTokenInfo
  • Authorization
  • ResourceMetadata
  • Resource
  • RequestMetadata
  • Status
  • TransferEventDetails
  • Transfer
  • Endpoint
  • EndpointSettings
  • MysqlSource
  • MysqlConnection
  • OnPremiseMysql
  • TLSMode
  • TLSConfig
  • ConnectionManagerConnection
  • Secret
  • MysqlObjectTransferSettings
  • PostgresSource
  • PostgresConnection
  • OnPremisePostgres
  • PostgresObjectTransferSettings
  • YdbSource
  • YDSSource
  • Parser
  • GenericParserCommon
  • DataSchema
  • FieldList
  • ColSchema
  • KafkaSource
  • KafkaConnectionOptions
  • OnPremiseKafka
  • KafkaAuth
  • KafkaSaslSecurity
  • DataTransformationOptions
  • MongoSource
  • MongoConnection
  • MongoConnectionOptions
  • OnPremiseMongo
  • MongoConnectionManagerConnection
  • MongoCollection
  • ClickhouseSource
  • ClickhouseConnection
  • ClickhouseConnectionOptions
  • OnPremiseClickhouse
  • ClickhouseShard
  • MysqlTarget
  • PostgresTarget
  • ClickhouseTarget
  • AltName
  • ClickhouseSharding
  • ColumnValueHash
  • ColumnValueMapping
  • ValueToShard
  • ColumnValue
  • YdbTarget
  • KafkaTarget
  • KafkaTargetTopicSettings
  • KafkaTargetTopic
  • Serializer
  • SerializerDebezium
  • DebeziumSerializerParameter
  • MongoTarget
  • MetrikaSource
  • MetrikaStream
  • YDSTarget
  • Runtime
  • YcRuntime
  • ShardingUploadParams
  • RegularSnapshot
  • RegularSnapshotSettings
  • IncrementalTable
  • RetryConfig
  • Transformation
  • Transformer
  • MaskFieldTransformer
  • TablesFilter
  • MaskFunction
  • MaskFunctionHash
  • FilterColumnsTransformer
  • ColumnsFilter
  • RenameTablesTransformer
  • RenameTable
  • Table
  • ReplacePrimaryKeyTransformer
  • ToStringTransformer
  • SharderTransformer
  • TableSplitterTransformer
  • FilterRowsTransformer
  • DataObjects

Event JSON schemaEvent JSON schema

{
  "eventId": "string",
  "eventSource": "string",
  "eventType": "string",
  "eventTime": "string",
  "authentication": {
    "authenticated": "boolean",
    // Includes only one of the fields `subjectType`
    "subjectType": "string",
    // end of the list of possible fields
    // Includes only one of the fields `subjectId`
    "subjectId": "string",
    // end of the list of possible fields
    // Includes only one of the fields `subjectName`
    "subjectName": "string",
    // end of the list of possible fields
    // Includes only one of the fields `federationId`
    "federationId": "string",
    // end of the list of possible fields
    // Includes only one of the fields `federationName`
    "federationName": "string",
    // end of the list of possible fields
    // Includes only one of the fields `federationType`
    "federationType": "string",
    // end of the list of possible fields
    "tokenInfo": {
      "maskedIamToken": "string",
      // Includes only one of the fields `iamTokenId`
      "iamTokenId": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorId`
      "impersonatorId": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorType`
      "impersonatorType": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorName`
      "impersonatorName": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorFederationId`
      "impersonatorFederationId": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorFederationName`
      "impersonatorFederationName": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorFederationType`
      "impersonatorFederationType": "string"
      // end of the list of possible fields
    }
  },
  "authorization": {
    "authorized": "boolean"
  },
  "resourceMetadata": {
    "path": [
      {
        "resourceType": "string",
        "resourceId": "string",
        // Includes only one of the fields `resourceName`
        "resourceName": "string"
        // end of the list of possible fields
      }
    ]
  },
  "requestMetadata": {
    "remoteAddress": "string",
    "userAgent": "string",
    "requestId": "string",
    // Includes only one of the fields `remotePort`
    "remotePort": "string"
    // end of the list of possible fields
  },
  "eventStatus": "string",
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "details": {
    "transferId": "string",
    "transferName": "string",
    "transfer": {
      "id": "string",
      "folderId": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "source": {
        "id": "string",
        "folderId": "string",
        "name": "string",
        "description": "string",
        "labels": "object",
        "settings": {
          // Includes only one of the fields `mysqlSource`, `postgresSource`, `ydbSource`, `ydsSource`, `kafkaSource`, `mongoSource`, `clickhouseSource`, `mysqlTarget`, `postgresTarget`, `clickhouseTarget`, `ydbTarget`, `kafkaTarget`, `mongoTarget`, `metrikaSource`, `ydsTarget`
          "mysqlSource": {
            "connection": {
              // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
              "mdbClusterId": "string",
              "onPremise": {
                "port": "string",
                "subnetId": "string",
                "hosts": [
                  "string"
                ],
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "user": "string",
            "password": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "timezone": "string",
            "objectTransferSettings": {
              "view": "string",
              "routine": "string",
              "trigger": "string",
              "tables": "string"
            },
            "includeTablesRegex": [
              "string"
            ],
            "excludeTablesRegex": [
              "string"
            ],
            "securityGroups": [
              "string"
            ],
            "serviceDatabase": "string"
          },
          "postgresSource": {
            "connection": {
              // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
              "mdbClusterId": "string",
              "onPremise": {
                "port": "string",
                "subnetId": "string",
                "hosts": [
                  "string"
                ],
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "user": "string",
            "password": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "includeTables": [
              "string"
            ],
            "excludeTables": [
              "string"
            ],
            "slotByteLagLimit": "string",
            "serviceSchema": "string",
            "objectTransferSettings": {
              "sequence": "string",
              "sequenceOwnedBy": "string",
              "table": "string",
              "primaryKey": "string",
              "fkConstraint": "string",
              "defaultValues": "string",
              "constraint": "string",
              "index": "string",
              "view": "string",
              "function": "string",
              "trigger": "string",
              "type": "string",
              "rule": "string",
              "collation": "string",
              "policy": "string",
              "cast": "string",
              "materializedView": "string",
              "sequenceSet": "string"
            },
            "securityGroups": [
              "string"
            ]
          },
          "ydbSource": {
            "database": "string",
            "instance": "string",
            "paths": [
              "string"
            ],
            "serviceAccountId": "string",
            "subnetId": "string",
            "saKeyContent": "string",
            "securityGroups": [
              "string"
            ],
            "changefeedCustomName": "string",
            "changefeedCustomConsumerName": "string"
          },
          "ydsSource": {
            "database": "string",
            "stream": "string",
            "serviceAccountId": "string",
            "supportedCodecs": [
              "string"
            ],
            "parser": {
              // Includes only one of the fields `jsonParser`, `auditTrailsV1Parser`, `cloudLoggingParser`, `tskvParser`
              "jsonParser": {
                "dataSchema": {
                  // Includes only one of the fields `jsonFields`, `fields`
                  "jsonFields": "string",
                  "fields": {
                    "fields": [
                      {
                        "name": "string",
                        "type": "string",
                        "key": "boolean",
                        "required": "boolean",
                        "path": "string"
                      }
                    ]
                  }
                  // end of the list of possible fields
                },
                "nullKeysAllowed": "boolean",
                "addRestColumn": "boolean",
                "unescapeStringValues": "boolean"
              },
              "auditTrailsV1Parser": "object",
              "cloudLoggingParser": "object",
              "tskvParser": {
                "dataSchema": {
                  // Includes only one of the fields `jsonFields`, `fields`
                  "jsonFields": "string",
                  "fields": {
                    "fields": [
                      {
                        "name": "string",
                        "type": "string",
                        "key": "boolean",
                        "required": "boolean",
                        "path": "string"
                      }
                    ]
                  }
                  // end of the list of possible fields
                },
                "nullKeysAllowed": "boolean",
                "addRestColumn": "boolean",
                "unescapeStringValues": "boolean"
              }
              // end of the list of possible fields
            },
            "allowTtlRewind": "boolean",
            "endpoint": "string",
            "subnetId": "string",
            "securityGroups": [
              "string"
            ],
            "consumer": "string"
          },
          "kafkaSource": {
            "connection": {
              // Includes only one of the fields `clusterId`, `onPremise`, `connectionManagerConnection`
              "clusterId": "string",
              "onPremise": {
                "brokerUrls": [
                  "string"
                ],
                "subnetId": "string",
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "auth": {
              // Includes only one of the fields `sasl`, `noAuth`
              "sasl": {
                "user": "string",
                "mechanism": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                }
              },
              "noAuth": "object"
              // end of the list of possible fields
            },
            "securityGroups": [
              "string"
            ],
            "topicName": "string",
            "transformer": {
              "cloudFunction": "string",
              "numberOfRetries": "string",
              "bufferSize": "string",
              "bufferFlushInterval": "string",
              "invocationTimeout": "string",
              "serviceAccountId": "string"
            },
            "parser": {
              // Includes only one of the fields `jsonParser`, `auditTrailsV1Parser`, `cloudLoggingParser`, `tskvParser`
              "jsonParser": {
                "dataSchema": {
                  // Includes only one of the fields `jsonFields`, `fields`
                  "jsonFields": "string",
                  "fields": {
                    "fields": [
                      {
                        "name": "string",
                        "type": "string",
                        "key": "boolean",
                        "required": "boolean",
                        "path": "string"
                      }
                    ]
                  }
                  // end of the list of possible fields
                },
                "nullKeysAllowed": "boolean",
                "addRestColumn": "boolean",
                "unescapeStringValues": "boolean"
              },
              "auditTrailsV1Parser": "object",
              "cloudLoggingParser": "object",
              "tskvParser": {
                "dataSchema": {
                  // Includes only one of the fields `jsonFields`, `fields`
                  "jsonFields": "string",
                  "fields": {
                    "fields": [
                      {
                        "name": "string",
                        "type": "string",
                        "key": "boolean",
                        "required": "boolean",
                        "path": "string"
                      }
                    ]
                  }
                  // end of the list of possible fields
                },
                "nullKeysAllowed": "boolean",
                "addRestColumn": "boolean",
                "unescapeStringValues": "boolean"
              }
              // end of the list of possible fields
            },
            "topicNames": [
              "string"
            ]
          },
          "mongoSource": {
            "connection": {
              // Includes only one of the fields `connectionOptions`
              "connectionOptions": {
                // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
                "mdbClusterId": "string",
                "onPremise": {
                  "hosts": [
                    "string"
                  ],
                  "port": "string",
                  "replicaSet": "string",
                  "tlsMode": {
                    // Includes only one of the fields `enabled`
                    "enabled": {
                      "caCertificate": "string"
                    }
                    // end of the list of possible fields
                  }
                },
                "connectionManagerConnection": {
                  "connectionId": "string",
                  "replicaSet": "string"
                },
                // end of the list of possible fields
                "user": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                },
                "authSource": "string"
              }
              // end of the list of possible fields
            },
            "subnetId": "string",
            "collections": [
              {
                "databaseName": "string",
                "collectionName": "string"
              }
            ],
            "excludedCollections": [
              {
                "databaseName": "string",
                "collectionName": "string"
              }
            ],
            "secondaryPreferredMode": "boolean",
            "securityGroups": [
              "string"
            ]
          },
          "clickhouseSource": {
            "connection": {
              // Includes only one of the fields `connectionOptions`
              "connectionOptions": {
                // Includes only one of the fields `onPremise`, `connectionManagerConnection`, `mdbClusterId`
                "onPremise": {
                  "shards": [
                    {
                      "name": "string",
                      "hosts": [
                        "string"
                      ]
                    }
                  ],
                  "httpPort": "string",
                  "nativePort": "string",
                  "tlsMode": {
                    // Includes only one of the fields `enabled`
                    "enabled": {
                      "caCertificate": "string"
                    }
                    // end of the list of possible fields
                  }
                },
                "connectionManagerConnection": {
                  "connectionId": "string",
                  "subnetId": "string"
                },
                "mdbClusterId": "string",
                // end of the list of possible fields
                "user": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                },
                "database": "string"
              }
              // end of the list of possible fields
            },
            "includeTables": [
              "string"
            ],
            "excludeTables": [
              "string"
            ],
            "subnetId": "string",
            "securityGroups": [
              "string"
            ],
            "clickhouseClusterName": "string"
          },
          "mysqlTarget": {
            "connection": {
              // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
              "mdbClusterId": "string",
              "onPremise": {
                "port": "string",
                "subnetId": "string",
                "hosts": [
                  "string"
                ],
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "user": "string",
            "password": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "sqlMode": "string",
            "skipConstraintChecks": "boolean",
            "timezone": "string",
            "cleanupPolicy": "string",
            "serviceDatabase": "string",
            "securityGroups": [
              "string"
            ],
            "isSchemaMigrationDisabled": "boolean"
          },
          "postgresTarget": {
            "connection": {
              // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
              "mdbClusterId": "string",
              "onPremise": {
                "port": "string",
                "subnetId": "string",
                "hosts": [
                  "string"
                ],
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "user": "string",
            "password": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "cleanupPolicy": "string",
            "securityGroups": [
              "string"
            ],
            "isSchemaMigrationDisabled": "boolean"
          },
          "clickhouseTarget": {
            "connection": {
              // Includes only one of the fields `connectionOptions`
              "connectionOptions": {
                // Includes only one of the fields `onPremise`, `connectionManagerConnection`, `mdbClusterId`
                "onPremise": {
                  "shards": [
                    {
                      "name": "string",
                      "hosts": [
                        "string"
                      ]
                    }
                  ],
                  "httpPort": "string",
                  "nativePort": "string",
                  "tlsMode": {
                    // Includes only one of the fields `enabled`
                    "enabled": {
                      "caCertificate": "string"
                    }
                    // end of the list of possible fields
                  }
                },
                "connectionManagerConnection": {
                  "connectionId": "string",
                  "subnetId": "string"
                },
                "mdbClusterId": "string",
                // end of the list of possible fields
                "user": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                },
                "database": "string"
              }
              // end of the list of possible fields
            },
            "subnetId": "string",
            "altNames": [
              {
                "fromName": "string",
                "toName": "string"
              }
            ],
            "cleanupPolicy": "string",
            "sharding": {
              // Includes only one of the fields `columnValueHash`, `customMapping`
              "columnValueHash": {
                "columnName": "string"
              },
              "customMapping": {
                "columnName": "string",
                "mapping": [
                  {
                    "columnValue": {
                      // Includes only one of the fields `stringValue`
                      "stringValue": "string"
                      // end of the list of possible fields
                    },
                    "shardName": "string"
                  }
                ]
              }
              // end of the list of possible fields
            },
            "isSchemaMigrationDisabled": "boolean",
            "clickhouseClusterName": "string",
            "securityGroups": [
              "string"
            ]
          },
          "ydbTarget": {
            "database": "string",
            "instance": "string",
            "path": "string",
            "serviceAccountId": "string",
            "cleanupPolicy": "string",
            "subnetId": "string",
            "saKeyContent": "string",
            "securityGroups": [
              "string"
            ],
            "isTableColumnOriented": "boolean",
            "defaultCompression": "string",
            "isSchemaMigrationDisabled": "boolean"
          },
          "kafkaTarget": {
            "connection": {
              // Includes only one of the fields `clusterId`, `onPremise`, `connectionManagerConnection`
              "clusterId": "string",
              "onPremise": {
                "brokerUrls": [
                  "string"
                ],
                "subnetId": "string",
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "auth": {
              // Includes only one of the fields `sasl`, `noAuth`
              "sasl": {
                "user": "string",
                "mechanism": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                }
              },
              "noAuth": "object"
              // end of the list of possible fields
            },
            "securityGroups": [
              "string"
            ],
            "topicSettings": {
              // Includes only one of the fields `topic`, `topicPrefix`
              "topic": {
                "topicName": "string",
                "saveTxOrder": "boolean"
              },
              "topicPrefix": "string"
              // end of the list of possible fields
            },
            "serializer": {
              // Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
              "serializerAuto": "object",
              "serializerJson": "object",
              "serializerDebezium": {
                "serializerParameters": [
                  {
                    "key": "string",
                    "value": "string"
                  }
                ]
              }
              // end of the list of possible fields
            }
          },
          "mongoTarget": {
            "connection": {
              // Includes only one of the fields `connectionOptions`
              "connectionOptions": {
                // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
                "mdbClusterId": "string",
                "onPremise": {
                  "hosts": [
                    "string"
                  ],
                  "port": "string",
                  "replicaSet": "string",
                  "tlsMode": {
                    // Includes only one of the fields `enabled`
                    "enabled": {
                      "caCertificate": "string"
                    }
                    // end of the list of possible fields
                  }
                },
                "connectionManagerConnection": {
                  "connectionId": "string",
                  "replicaSet": "string"
                },
                // end of the list of possible fields
                "user": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                },
                "authSource": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "cleanupPolicy": "string",
            "subnetId": "string",
            "securityGroups": [
              "string"
            ]
          },
          "metrikaSource": {
            "counterIds": [
              "string"
            ],
            "token": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "streams": [
              {
                "type": "string",
                "columns": [
                  "string"
                ]
              }
            ]
          },
          "ydsTarget": {
            "database": "string",
            "stream": "string",
            "serviceAccountId": "string",
            "saveTxOrder": "boolean",
            "compressionCodec": "string",
            "serializer": {
              // Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
              "serializerAuto": "object",
              "serializerJson": "object",
              "serializerDebezium": {
                "serializerParameters": [
                  {
                    "key": "string",
                    "value": "string"
                  }
                ]
              }
              // end of the list of possible fields
            },
            "endpoint": "string",
            "subnetId": "string",
            "securityGroups": [
              "string"
            ]
          }
          // end of the list of possible fields
        }
      },
      "target": {
        "id": "string",
        "folderId": "string",
        "name": "string",
        "description": "string",
        "labels": "object",
        "settings": {
          // Includes only one of the fields `mysqlSource`, `postgresSource`, `ydbSource`, `ydsSource`, `kafkaSource`, `mongoSource`, `clickhouseSource`, `mysqlTarget`, `postgresTarget`, `clickhouseTarget`, `ydbTarget`, `kafkaTarget`, `mongoTarget`, `metrikaSource`, `ydsTarget`
          "mysqlSource": {
            "connection": {
              // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
              "mdbClusterId": "string",
              "onPremise": {
                "port": "string",
                "subnetId": "string",
                "hosts": [
                  "string"
                ],
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "user": "string",
            "password": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "timezone": "string",
            "objectTransferSettings": {
              "view": "string",
              "routine": "string",
              "trigger": "string",
              "tables": "string"
            },
            "includeTablesRegex": [
              "string"
            ],
            "excludeTablesRegex": [
              "string"
            ],
            "securityGroups": [
              "string"
            ],
            "serviceDatabase": "string"
          },
          "postgresSource": {
            "connection": {
              // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
              "mdbClusterId": "string",
              "onPremise": {
                "port": "string",
                "subnetId": "string",
                "hosts": [
                  "string"
                ],
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "user": "string",
            "password": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "includeTables": [
              "string"
            ],
            "excludeTables": [
              "string"
            ],
            "slotByteLagLimit": "string",
            "serviceSchema": "string",
            "objectTransferSettings": {
              "sequence": "string",
              "sequenceOwnedBy": "string",
              "table": "string",
              "primaryKey": "string",
              "fkConstraint": "string",
              "defaultValues": "string",
              "constraint": "string",
              "index": "string",
              "view": "string",
              "function": "string",
              "trigger": "string",
              "type": "string",
              "rule": "string",
              "collation": "string",
              "policy": "string",
              "cast": "string",
              "materializedView": "string",
              "sequenceSet": "string"
            },
            "securityGroups": [
              "string"
            ]
          },
          "ydbSource": {
            "database": "string",
            "instance": "string",
            "paths": [
              "string"
            ],
            "serviceAccountId": "string",
            "subnetId": "string",
            "saKeyContent": "string",
            "securityGroups": [
              "string"
            ],
            "changefeedCustomName": "string",
            "changefeedCustomConsumerName": "string"
          },
          "ydsSource": {
            "database": "string",
            "stream": "string",
            "serviceAccountId": "string",
            "supportedCodecs": [
              "string"
            ],
            "parser": {
              // Includes only one of the fields `jsonParser`, `auditTrailsV1Parser`, `cloudLoggingParser`, `tskvParser`
              "jsonParser": {
                "dataSchema": {
                  // Includes only one of the fields `jsonFields`, `fields`
                  "jsonFields": "string",
                  "fields": {
                    "fields": [
                      {
                        "name": "string",
                        "type": "string",
                        "key": "boolean",
                        "required": "boolean",
                        "path": "string"
                      }
                    ]
                  }
                  // end of the list of possible fields
                },
                "nullKeysAllowed": "boolean",
                "addRestColumn": "boolean",
                "unescapeStringValues": "boolean"
              },
              "auditTrailsV1Parser": "object",
              "cloudLoggingParser": "object",
              "tskvParser": {
                "dataSchema": {
                  // Includes only one of the fields `jsonFields`, `fields`
                  "jsonFields": "string",
                  "fields": {
                    "fields": [
                      {
                        "name": "string",
                        "type": "string",
                        "key": "boolean",
                        "required": "boolean",
                        "path": "string"
                      }
                    ]
                  }
                  // end of the list of possible fields
                },
                "nullKeysAllowed": "boolean",
                "addRestColumn": "boolean",
                "unescapeStringValues": "boolean"
              }
              // end of the list of possible fields
            },
            "allowTtlRewind": "boolean",
            "endpoint": "string",
            "subnetId": "string",
            "securityGroups": [
              "string"
            ],
            "consumer": "string"
          },
          "kafkaSource": {
            "connection": {
              // Includes only one of the fields `clusterId`, `onPremise`, `connectionManagerConnection`
              "clusterId": "string",
              "onPremise": {
                "brokerUrls": [
                  "string"
                ],
                "subnetId": "string",
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "auth": {
              // Includes only one of the fields `sasl`, `noAuth`
              "sasl": {
                "user": "string",
                "mechanism": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                }
              },
              "noAuth": "object"
              // end of the list of possible fields
            },
            "securityGroups": [
              "string"
            ],
            "topicName": "string",
            "transformer": {
              "cloudFunction": "string",
              "numberOfRetries": "string",
              "bufferSize": "string",
              "bufferFlushInterval": "string",
              "invocationTimeout": "string",
              "serviceAccountId": "string"
            },
            "parser": {
              // Includes only one of the fields `jsonParser`, `auditTrailsV1Parser`, `cloudLoggingParser`, `tskvParser`
              "jsonParser": {
                "dataSchema": {
                  // Includes only one of the fields `jsonFields`, `fields`
                  "jsonFields": "string",
                  "fields": {
                    "fields": [
                      {
                        "name": "string",
                        "type": "string",
                        "key": "boolean",
                        "required": "boolean",
                        "path": "string"
                      }
                    ]
                  }
                  // end of the list of possible fields
                },
                "nullKeysAllowed": "boolean",
                "addRestColumn": "boolean",
                "unescapeStringValues": "boolean"
              },
              "auditTrailsV1Parser": "object",
              "cloudLoggingParser": "object",
              "tskvParser": {
                "dataSchema": {
                  // Includes only one of the fields `jsonFields`, `fields`
                  "jsonFields": "string",
                  "fields": {
                    "fields": [
                      {
                        "name": "string",
                        "type": "string",
                        "key": "boolean",
                        "required": "boolean",
                        "path": "string"
                      }
                    ]
                  }
                  // end of the list of possible fields
                },
                "nullKeysAllowed": "boolean",
                "addRestColumn": "boolean",
                "unescapeStringValues": "boolean"
              }
              // end of the list of possible fields
            },
            "topicNames": [
              "string"
            ]
          },
          "mongoSource": {
            "connection": {
              // Includes only one of the fields `connectionOptions`
              "connectionOptions": {
                // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
                "mdbClusterId": "string",
                "onPremise": {
                  "hosts": [
                    "string"
                  ],
                  "port": "string",
                  "replicaSet": "string",
                  "tlsMode": {
                    // Includes only one of the fields `enabled`
                    "enabled": {
                      "caCertificate": "string"
                    }
                    // end of the list of possible fields
                  }
                },
                "connectionManagerConnection": {
                  "connectionId": "string",
                  "replicaSet": "string"
                },
                // end of the list of possible fields
                "user": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                },
                "authSource": "string"
              }
              // end of the list of possible fields
            },
            "subnetId": "string",
            "collections": [
              {
                "databaseName": "string",
                "collectionName": "string"
              }
            ],
            "excludedCollections": [
              {
                "databaseName": "string",
                "collectionName": "string"
              }
            ],
            "secondaryPreferredMode": "boolean",
            "securityGroups": [
              "string"
            ]
          },
          "clickhouseSource": {
            "connection": {
              // Includes only one of the fields `connectionOptions`
              "connectionOptions": {
                // Includes only one of the fields `onPremise`, `connectionManagerConnection`, `mdbClusterId`
                "onPremise": {
                  "shards": [
                    {
                      "name": "string",
                      "hosts": [
                        "string"
                      ]
                    }
                  ],
                  "httpPort": "string",
                  "nativePort": "string",
                  "tlsMode": {
                    // Includes only one of the fields `enabled`
                    "enabled": {
                      "caCertificate": "string"
                    }
                    // end of the list of possible fields
                  }
                },
                "connectionManagerConnection": {
                  "connectionId": "string",
                  "subnetId": "string"
                },
                "mdbClusterId": "string",
                // end of the list of possible fields
                "user": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                },
                "database": "string"
              }
              // end of the list of possible fields
            },
            "includeTables": [
              "string"
            ],
            "excludeTables": [
              "string"
            ],
            "subnetId": "string",
            "securityGroups": [
              "string"
            ],
            "clickhouseClusterName": "string"
          },
          "mysqlTarget": {
            "connection": {
              // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
              "mdbClusterId": "string",
              "onPremise": {
                "port": "string",
                "subnetId": "string",
                "hosts": [
                  "string"
                ],
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "user": "string",
            "password": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "sqlMode": "string",
            "skipConstraintChecks": "boolean",
            "timezone": "string",
            "cleanupPolicy": "string",
            "serviceDatabase": "string",
            "securityGroups": [
              "string"
            ],
            "isSchemaMigrationDisabled": "boolean"
          },
          "postgresTarget": {
            "connection": {
              // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
              "mdbClusterId": "string",
              "onPremise": {
                "port": "string",
                "subnetId": "string",
                "hosts": [
                  "string"
                ],
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "user": "string",
            "password": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "cleanupPolicy": "string",
            "securityGroups": [
              "string"
            ],
            "isSchemaMigrationDisabled": "boolean"
          },
          "clickhouseTarget": {
            "connection": {
              // Includes only one of the fields `connectionOptions`
              "connectionOptions": {
                // Includes only one of the fields `onPremise`, `connectionManagerConnection`, `mdbClusterId`
                "onPremise": {
                  "shards": [
                    {
                      "name": "string",
                      "hosts": [
                        "string"
                      ]
                    }
                  ],
                  "httpPort": "string",
                  "nativePort": "string",
                  "tlsMode": {
                    // Includes only one of the fields `enabled`
                    "enabled": {
                      "caCertificate": "string"
                    }
                    // end of the list of possible fields
                  }
                },
                "connectionManagerConnection": {
                  "connectionId": "string",
                  "subnetId": "string"
                },
                "mdbClusterId": "string",
                // end of the list of possible fields
                "user": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                },
                "database": "string"
              }
              // end of the list of possible fields
            },
            "subnetId": "string",
            "altNames": [
              {
                "fromName": "string",
                "toName": "string"
              }
            ],
            "cleanupPolicy": "string",
            "sharding": {
              // Includes only one of the fields `columnValueHash`, `customMapping`
              "columnValueHash": {
                "columnName": "string"
              },
              "customMapping": {
                "columnName": "string",
                "mapping": [
                  {
                    "columnValue": {
                      // Includes only one of the fields `stringValue`
                      "stringValue": "string"
                      // end of the list of possible fields
                    },
                    "shardName": "string"
                  }
                ]
              }
              // end of the list of possible fields
            },
            "isSchemaMigrationDisabled": "boolean",
            "clickhouseClusterName": "string",
            "securityGroups": [
              "string"
            ]
          },
          "ydbTarget": {
            "database": "string",
            "instance": "string",
            "path": "string",
            "serviceAccountId": "string",
            "cleanupPolicy": "string",
            "subnetId": "string",
            "saKeyContent": "string",
            "securityGroups": [
              "string"
            ],
            "isTableColumnOriented": "boolean",
            "defaultCompression": "string",
            "isSchemaMigrationDisabled": "boolean"
          },
          "kafkaTarget": {
            "connection": {
              // Includes only one of the fields `clusterId`, `onPremise`, `connectionManagerConnection`
              "clusterId": "string",
              "onPremise": {
                "brokerUrls": [
                  "string"
                ],
                "subnetId": "string",
                "tlsMode": {
                  // Includes only one of the fields `enabled`
                  "enabled": {
                    "caCertificate": "string"
                  }
                  // end of the list of possible fields
                }
              },
              "connectionManagerConnection": {
                "connectionId": "string",
                "subnetId": "string"
              }
              // end of the list of possible fields
            },
            "auth": {
              // Includes only one of the fields `sasl`, `noAuth`
              "sasl": {
                "user": "string",
                "mechanism": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                }
              },
              "noAuth": "object"
              // end of the list of possible fields
            },
            "securityGroups": [
              "string"
            ],
            "topicSettings": {
              // Includes only one of the fields `topic`, `topicPrefix`
              "topic": {
                "topicName": "string",
                "saveTxOrder": "boolean"
              },
              "topicPrefix": "string"
              // end of the list of possible fields
            },
            "serializer": {
              // Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
              "serializerAuto": "object",
              "serializerJson": "object",
              "serializerDebezium": {
                "serializerParameters": [
                  {
                    "key": "string",
                    "value": "string"
                  }
                ]
              }
              // end of the list of possible fields
            }
          },
          "mongoTarget": {
            "connection": {
              // Includes only one of the fields `connectionOptions`
              "connectionOptions": {
                // Includes only one of the fields `mdbClusterId`, `onPremise`, `connectionManagerConnection`
                "mdbClusterId": "string",
                "onPremise": {
                  "hosts": [
                    "string"
                  ],
                  "port": "string",
                  "replicaSet": "string",
                  "tlsMode": {
                    // Includes only one of the fields `enabled`
                    "enabled": {
                      "caCertificate": "string"
                    }
                    // end of the list of possible fields
                  }
                },
                "connectionManagerConnection": {
                  "connectionId": "string",
                  "replicaSet": "string"
                },
                // end of the list of possible fields
                "user": "string",
                "password": {
                  // Includes only one of the fields `raw`
                  "raw": "string"
                  // end of the list of possible fields
                },
                "authSource": "string"
              }
              // end of the list of possible fields
            },
            "database": "string",
            "cleanupPolicy": "string",
            "subnetId": "string",
            "securityGroups": [
              "string"
            ]
          },
          "metrikaSource": {
            "counterIds": [
              "string"
            ],
            "token": {
              // Includes only one of the fields `raw`
              "raw": "string"
              // end of the list of possible fields
            },
            "streams": [
              {
                "type": "string",
                "columns": [
                  "string"
                ]
              }
            ]
          },
          "ydsTarget": {
            "database": "string",
            "stream": "string",
            "serviceAccountId": "string",
            "saveTxOrder": "boolean",
            "compressionCodec": "string",
            "serializer": {
              // Includes only one of the fields `serializerAuto`, `serializerJson`, `serializerDebezium`
              "serializerAuto": "object",
              "serializerJson": "object",
              "serializerDebezium": {
                "serializerParameters": [
                  {
                    "key": "string",
                    "value": "string"
                  }
                ]
              }
              // end of the list of possible fields
            },
            "endpoint": "string",
            "subnetId": "string",
            "securityGroups": [
              "string"
            ]
          }
          // end of the list of possible fields
        }
      },
      "runtime": {
        // Includes only one of the fields `ycRuntime`
        "ycRuntime": {
          "jobCount": "string",
          "flavor": "string",
          "uploadShardParams": {
            "jobCount": "string",
            "processCount": "string"
          }
        }
        // end of the list of possible fields
      },
      "status": "string",
      "type": "string",
      "warning": "string",
      "regularSnapshot": {
        // Includes only one of the fields `settings`, `disabled`
        "settings": {
          "schedule": "string",
          "tables": [
            {
              "tableNamespace": "string",
              "tableName": "string",
              "cursorColumn": "string",
              "initialState": "string"
            }
          ],
          "cronExpression": "string",
          "incrementDelaySeconds": "string",
          "retryConfig": {
            "maxAttempts": "string"
          }
        },
        "disabled": "object"
        // end of the list of possible fields
      },
      "transformation": {
        "transformers": [
          {
            // Includes only one of the fields `maskField`, `filterColumns`, `renameTables`, `replacePrimaryKey`, `convertToString`, `sharderTransformer`, `tableSplitterTransformer`, `filterRows`
            "maskField": {
              "tables": {
                "includeTables": [
                  "string"
                ],
                "excludeTables": [
                  "string"
                ]
              },
              "columns": [
                "string"
              ],
              "function": {
                // Includes only one of the fields `maskFunctionHash`
                "maskFunctionHash": {
                  "userDefinedSalt": "string"
                }
                // end of the list of possible fields
              }
            },
            "filterColumns": {
              "tables": {
                "includeTables": [
                  "string"
                ],
                "excludeTables": [
                  "string"
                ]
              },
              "columns": {
                "includeColumns": [
                  "string"
                ],
                "excludeColumns": [
                  "string"
                ]
              }
            },
            "renameTables": {
              "renameTables": [
                {
                  "originalName": {
                    "nameSpace": "string",
                    "name": "string"
                  },
                  "newName": {
                    "nameSpace": "string",
                    "name": "string"
                  }
                }
              ]
            },
            "replacePrimaryKey": {
              "tables": {
                "includeTables": [
                  "string"
                ],
                "excludeTables": [
                  "string"
                ]
              },
              "keys": [
                "string"
              ]
            },
            "convertToString": {
              "tables": {
                "includeTables": [
                  "string"
                ],
                "excludeTables": [
                  "string"
                ]
              },
              "columns": {
                "includeColumns": [
                  "string"
                ],
                "excludeColumns": [
                  "string"
                ]
              },
              "skipUtcConversion": "boolean"
            },
            "sharderTransformer": {
              // Includes only one of the fields `columns`, `random`
              "columns": {
                "includeColumns": [
                  "string"
                ],
                "excludeColumns": [
                  "string"
                ]
              },
              "random": "object",
              // end of the list of possible fields
              "tables": {
                "includeTables": [
                  "string"
                ],
                "excludeTables": [
                  "string"
                ]
              },
              "shardsCount": "string"
            },
            "tableSplitterTransformer": {
              "tables": {
                "includeTables": [
                  "string"
                ],
                "excludeTables": [
                  "string"
                ]
              },
              "columns": [
                "string"
              ],
              "splitter": "string"
            },
            "filterRows": {
              "tables": {
                "includeTables": [
                  "string"
                ],
                "excludeTables": [
                  "string"
                ]
              },
              "filter": "string",
              "filters": [
                "string"
              ]
            }
            // end of the list of possible fields
          }
        ]
      },
      "dataObjects": {
        "includeObjects": [
          "string"
        ]
      },
      "prestable": "boolean",
      "replicationRuntime": {
        // Includes only one of the fields `ycRuntime`
        "ycRuntime": {
          "jobCount": "string",
          "flavor": "string",
          "uploadShardParams": {
            "jobCount": "string",
            "processCount": "string"
          }
        }
        // end of the list of possible fields
      }
    }
  },
  "requestParameters": "object",
  "response": "object"
}

Field descriptionField description

Field

Description

eventId

string

eventSource

string

eventType

string

eventTime

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

authentication

IamAuthentication

authorization

Authorization

resourceMetadata

ResourceMetadata

requestMetadata

RequestMetadata

eventStatus

enum (EventStatus)

  • STARTED
  • ERROR
  • DONE
  • CANCELLED
  • RUNNING

error

Status

The error result of the operation in case of failure or cancellation.

details

TransferEventDetails

requestParameters

object

response

object

IamAuthenticationIamAuthentication

Field

Description

authenticated

boolean

subjectType

enum (IamSubjectType)

Includes only one of the fields subjectType.

  • YANDEX_PASSPORT_USER_ACCOUNT
  • SERVICE_ACCOUNT
  • FEDERATED_USER_ACCOUNT
  • SSH_USER
  • KUBERNETES_USER

subjectId

string

Includes only one of the fields subjectId.

subjectName

string

Includes only one of the fields subjectName.

federationId

string

Includes only one of the fields federationId.

federationName

string

Includes only one of the fields federationName.

federationType

enum (FederationType)

Includes only one of the fields federationType.

  • GLOBAL_FEDERATION
  • PRIVATE_FEDERATION

tokenInfo

IamTokenInfo

IamTokenInfoIamTokenInfo

Field

Description

maskedIamToken

string

iamTokenId

string

Includes only one of the fields iamTokenId.

impersonatorId

string

Includes only one of the fields impersonatorId.

impersonatorType

enum (IamSubjectType)

Includes only one of the fields impersonatorType.

  • YANDEX_PASSPORT_USER_ACCOUNT
  • SERVICE_ACCOUNT
  • FEDERATED_USER_ACCOUNT
  • SSH_USER
  • KUBERNETES_USER

impersonatorName

string

Includes only one of the fields impersonatorName.

impersonatorFederationId

string

Includes only one of the fields impersonatorFederationId.

impersonatorFederationName

string

Includes only one of the fields impersonatorFederationName.

impersonatorFederationType

enum (FederationType)

Includes only one of the fields impersonatorFederationType.

  • GLOBAL_FEDERATION
  • PRIVATE_FEDERATION

AuthorizationAuthorization

Field

Description

authorized

boolean

ResourceMetadataResourceMetadata

Field

Description

path[]

Resource

ResourceResource

Field

Description

resourceType

string

resourceId

string

resourceName

string

Includes only one of the fields resourceName.

RequestMetadataRequestMetadata

Field

Description

remoteAddress

string

userAgent

string

requestId

string

remotePort

string (int64)

Includes only one of the fields remotePort.

StatusStatus

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

TransferEventDetailsTransferEventDetails

Field

Description

transferId

string

The maximum string length in characters is 50.

transferName

string

transfer

Transfer

TransferTransfer

Field

Description

id

string

folderId

string

name

string

description

string

labels

object (map<string, string>)

source

Endpoint

target

Endpoint

runtime

Runtime

status

enum (TransferStatus)

  • CREATING
  • CREATED
  • RUNNING
  • STOPPING
  • STOPPED
  • ERROR
  • SNAPSHOTTING
  • DONE
  • PAUSED
  • PREPARING

type

enum (TransferType)

  • SNAPSHOT_AND_INCREMENT
  • SNAPSHOT_ONLY
  • INCREMENT_ONLY

warning

string

regularSnapshot

RegularSnapshot

transformation

Transformation

dataObjects

DataObjects

prestable

boolean

replicationRuntime

Runtime

EndpointEndpoint

Field

Description

id

string

folderId

string

name

string

description

string

labels

object (map<string, string>)

settings

EndpointSettings

EndpointSettingsEndpointSettings

Field

Description

mysqlSource

MysqlSource

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

postgresSource

PostgresSource

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

ydbSource

YdbSource

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

ydsSource

YDSSource

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

kafkaSource

KafkaSource

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

mongoSource

MongoSource

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

clickhouseSource

ClickhouseSource

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

mysqlTarget

MysqlTarget

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

postgresTarget

PostgresTarget

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

clickhouseTarget

ClickhouseTarget

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

ydbTarget

YdbTarget

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

kafkaTarget

KafkaTarget

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

mongoTarget

MongoTarget

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

metrikaSource

MetrikaSource

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

ydsTarget

YDSTarget

Includes only one of the fields mysqlSource, postgresSource, ydbSource, ydsSource, kafkaSource, mongoSource, clickhouseSource, mysqlTarget, postgresTarget, clickhouseTarget, ydbTarget, kafkaTarget, mongoTarget, metrikaSource, ydsTarget.

MysqlSourceMysqlSource

Field

Description

connection

MysqlConnection

database

string

user

string

password

Secret

timezone

string

objectTransferSettings

MysqlObjectTransferSettings

includeTablesRegex[]

string

excludeTablesRegex[]

string

securityGroups[]

string

serviceDatabase

string

MysqlConnectionMysqlConnection

Field

Description

mdbClusterId

string

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

onPremise

OnPremiseMysql

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

connectionManagerConnection

ConnectionManagerConnection

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

OnPremiseMysqlOnPremiseMysql

Field

Description

port

string (int64)

subnetId

string

hosts[]

string

tlsMode

TLSMode

TLSModeTLSMode

Field

Description

enabled

TLSConfig

Includes only one of the fields enabled.

TLSConfigTLSConfig

Field

Description

caCertificate

string

ConnectionManagerConnectionConnectionManagerConnection

Field

Description

connectionId

string

subnetId

string

SecretSecret

Field

Description

raw

string

Includes only one of the fields raw.

MysqlObjectTransferSettingsMysqlObjectTransferSettings

Field

Description

view

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

routine

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

trigger

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

tables

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

PostgresSourcePostgresSource

Field

Description

connection

PostgresConnection

database

string

user

string

password

Secret

includeTables[]

string

excludeTables[]

string

slotByteLagLimit

string (int64)

serviceSchema

string

objectTransferSettings

PostgresObjectTransferSettings

securityGroups[]

string

PostgresConnectionPostgresConnection

Field

Description

mdbClusterId

string

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

onPremise

OnPremisePostgres

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

connectionManagerConnection

ConnectionManagerConnection

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

OnPremisePostgresOnPremisePostgres

Field

Description

port

string (int64)

subnetId

string

hosts[]

string

tlsMode

TLSMode

PostgresObjectTransferSettingsPostgresObjectTransferSettings

Field

Description

sequence

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

sequenceOwnedBy

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

table

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

primaryKey

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

fkConstraint

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

defaultValues

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

constraint

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

index

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

view

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

function

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

trigger

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

type

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

rule

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

collation

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

policy

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

cast

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

materializedView

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

sequenceSet

enum (ObjectTransferStage)

  • BEFORE_DATA
  • AFTER_DATA
  • NEVER

YdbSourceYdbSource

Field

Description

database

string

instance

string

paths[]

string

serviceAccountId

string

subnetId

string

saKeyContent

string

securityGroups[]

string

changefeedCustomName

string

changefeedCustomConsumerName

string

YDSSourceYDSSource

Field

Description

database

string

stream

string

serviceAccountId

string

supportedCodecs[]

enum (YdsCompressionCodec)

  • YDS_COMPRESSION_CODEC_RAW
  • YDS_COMPRESSION_CODEC_GZIP
  • YDS_COMPRESSION_CODEC_ZSTD

parser

Parser

allowTtlRewind

boolean

endpoint

string

subnetId

string

securityGroups[]

string

consumer

string

ParserParser

Field

Description

jsonParser

GenericParserCommon

Includes only one of the fields jsonParser, auditTrailsV1Parser, cloudLoggingParser, tskvParser.

auditTrailsV1Parser

object

Includes only one of the fields jsonParser, auditTrailsV1Parser, cloudLoggingParser, tskvParser.

cloudLoggingParser

object

Includes only one of the fields jsonParser, auditTrailsV1Parser, cloudLoggingParser, tskvParser.

tskvParser

GenericParserCommon

Includes only one of the fields jsonParser, auditTrailsV1Parser, cloudLoggingParser, tskvParser.

GenericParserCommonGenericParserCommon

Field

Description

dataSchema

DataSchema

nullKeysAllowed

boolean

addRestColumn

boolean

unescapeStringValues

boolean

DataSchemaDataSchema

Field

Description

jsonFields

string

Includes only one of the fields jsonFields, fields.

fields

FieldList

Includes only one of the fields jsonFields, fields.

FieldListFieldList

Field

Description

fields[]

ColSchema

ColSchemaColSchema

Field

Description

name

string

type

enum (ColumnType)

  • INT32
  • INT16
  • INT8
  • UINT64
  • UINT32
  • UINT16
  • UINT8
  • DOUBLE
  • BOOLEAN
  • STRING
  • UTF8
  • ANY
  • DATETIME
  • INT64

key

boolean

required

boolean

path

string

KafkaSourceKafkaSource

Field

Description

connection

KafkaConnectionOptions

auth

KafkaAuth

securityGroups[]

string

topicName

string

transformer

DataTransformationOptions

parser

Parser

topicNames[]

string

KafkaConnectionOptionsKafkaConnectionOptions

Field

Description

clusterId

string

Includes only one of the fields clusterId, onPremise, connectionManagerConnection.

onPremise

OnPremiseKafka

Includes only one of the fields clusterId, onPremise, connectionManagerConnection.

connectionManagerConnection

ConnectionManagerConnection

Includes only one of the fields clusterId, onPremise, connectionManagerConnection.

OnPremiseKafkaOnPremiseKafka

Field

Description

brokerUrls[]

string

subnetId

string

tlsMode

TLSMode

KafkaAuthKafkaAuth

Field

Description

sasl

KafkaSaslSecurity

Includes only one of the fields sasl, noAuth.

noAuth

object

Includes only one of the fields sasl, noAuth.

KafkaSaslSecurityKafkaSaslSecurity

Field

Description

user

string

mechanism

enum (KafkaMechanism)

  • KAFKA_MECHANISM_SHA256
  • KAFKA_MECHANISM_SHA512

password

Secret

DataTransformationOptionsDataTransformationOptions

Field

Description

cloudFunction

string

numberOfRetries

string (int64)

bufferSize

string

bufferFlushInterval

string

invocationTimeout

string

serviceAccountId

string

MongoSourceMongoSource

Field

Description

connection

MongoConnection

subnetId

string

collections[]

MongoCollection

excludedCollections[]

MongoCollection

secondaryPreferredMode

boolean

securityGroups[]

string

MongoConnectionMongoConnection

Field

Description

connectionOptions

MongoConnectionOptions

Includes only one of the fields connectionOptions.

MongoConnectionOptionsMongoConnectionOptions

Field

Description

mdbClusterId

string

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

onPremise

OnPremiseMongo

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

connectionManagerConnection

MongoConnectionManagerConnection

Includes only one of the fields mdbClusterId, onPremise, connectionManagerConnection.

user

string

password

Secret

authSource

string

OnPremiseMongoOnPremiseMongo

Field

Description

hosts[]

string

port

string (int64)

replicaSet

string

tlsMode

TLSMode

MongoConnectionManagerConnectionMongoConnectionManagerConnection

Field

Description

connectionId

string

replicaSet

string

MongoCollectionMongoCollection

Field

Description

databaseName

string

collectionName

string

ClickhouseSourceClickhouseSource

Field

Description

connection

ClickhouseConnection

includeTables[]

string

excludeTables[]

string

subnetId

string

securityGroups[]

string

clickhouseClusterName

string

ClickhouseConnectionClickhouseConnection

Field

Description

connectionOptions

ClickhouseConnectionOptions

Includes only one of the fields connectionOptions.

ClickhouseConnectionOptionsClickhouseConnectionOptions

Field

Description

onPremise

OnPremiseClickhouse

Includes only one of the fields onPremise, connectionManagerConnection, mdbClusterId.

connectionManagerConnection

ConnectionManagerConnection

Includes only one of the fields onPremise, connectionManagerConnection, mdbClusterId.

mdbClusterId

string

Includes only one of the fields onPremise, connectionManagerConnection, mdbClusterId.

user

string

password

Secret

database

string

OnPremiseClickhouseOnPremiseClickhouse

Field

Description

shards[]

ClickhouseShard

httpPort

string (int64)

nativePort

string (int64)

tlsMode

TLSMode

ClickhouseShardClickhouseShard

Field

Description

name

string

hosts[]

string

MysqlTargetMysqlTarget

Field

Description

connection

MysqlConnection

database

string

user

string

password

Secret

sqlMode

string

skipConstraintChecks

boolean

timezone

string

cleanupPolicy

enum (CleanupPolicy)

  • DISABLED
  • DROP
  • TRUNCATE

serviceDatabase

string

securityGroups[]

string

isSchemaMigrationDisabled

boolean

PostgresTargetPostgresTarget

Field

Description

connection

PostgresConnection

database

string

user

string

password

Secret

cleanupPolicy

enum (CleanupPolicy)

  • DISABLED
  • DROP
  • TRUNCATE

securityGroups[]

string

isSchemaMigrationDisabled

boolean

ClickhouseTargetClickhouseTarget

Field

Description

connection

ClickhouseConnection

subnetId

string

altNames[]

AltName

cleanupPolicy

enum (ClickhouseCleanupPolicy)

  • CLICKHOUSE_CLEANUP_POLICY_DISABLED
  • CLICKHOUSE_CLEANUP_POLICY_DROP
  • CLICKHOUSE_CLEANUP_POLICY_TRUNCATE

sharding

ClickhouseSharding

isSchemaMigrationDisabled

boolean

clickhouseClusterName

string

securityGroups[]

string

AltNameAltName

Field

Description

fromName

string

toName

string

ClickhouseShardingClickhouseSharding

Field

Description

columnValueHash

ColumnValueHash

Includes only one of the fields columnValueHash, customMapping.

customMapping

ColumnValueMapping

Includes only one of the fields columnValueHash, customMapping.

ColumnValueHashColumnValueHash

Field

Description

columnName

string

ColumnValueMappingColumnValueMapping

Field

Description

columnName

string

mapping[]

ValueToShard

ValueToShardValueToShard

Field

Description

columnValue

ColumnValue

shardName

string

ColumnValueColumnValue

Field

Description

stringValue

string

Includes only one of the fields stringValue.

YdbTargetYdbTarget

Field

Description

database

string

instance

string

path

string

serviceAccountId

string

cleanupPolicy

enum (YdbCleanupPolicy)

  • YDB_CLEANUP_POLICY_DISABLED
  • YDB_CLEANUP_POLICY_DROP

subnetId

string

saKeyContent

string

securityGroups[]

string

isTableColumnOriented

boolean

defaultCompression

enum (YdbDefaultCompression)

  • YDB_DEFAULT_COMPRESSION_DISABLED
  • YDB_DEFAULT_COMPRESSION_LZ4

isSchemaMigrationDisabled

boolean

KafkaTargetKafkaTarget

Field

Description

connection

KafkaConnectionOptions

auth

KafkaAuth

securityGroups[]

string

topicSettings

KafkaTargetTopicSettings

serializer

Serializer

KafkaTargetTopicSettingsKafkaTargetTopicSettings

Field

Description

topic

KafkaTargetTopic

Includes only one of the fields topic, topicPrefix.

topicPrefix

string

Includes only one of the fields topic, topicPrefix.

KafkaTargetTopicKafkaTargetTopic

Field

Description

topicName

string

saveTxOrder

boolean

SerializerSerializer

Field

Description

serializerAuto

object

Includes only one of the fields serializerAuto, serializerJson, serializerDebezium.

serializerJson

object

Includes only one of the fields serializerAuto, serializerJson, serializerDebezium.

serializerDebezium

SerializerDebezium

Includes only one of the fields serializerAuto, serializerJson, serializerDebezium.

SerializerDebeziumSerializerDebezium

Field

Description

serializerParameters[]

DebeziumSerializerParameter

DebeziumSerializerParameterDebeziumSerializerParameter

Field

Description

key

string

value

string

MongoTargetMongoTarget

Field

Description

connection

MongoConnection

database

string

cleanupPolicy

enum (CleanupPolicy)

  • DISABLED
  • DROP
  • TRUNCATE

subnetId

string

securityGroups[]

string

MetrikaSourceMetrikaSource

Field

Description

counterIds[]

string (int64)

token

Secret

streams[]

MetrikaStream

MetrikaStreamMetrikaStream

Field

Description

type

enum (MetrikaStreamType)

  • METRIKA_STREAM_TYPE_HITS
  • METRIKA_STREAM_TYPE_VISITS
  • METRIKA_STREAM_TYPE_HITS_V2

columns[]

string

YDSTargetYDSTarget

Field

Description

database

string

stream

string

serviceAccountId

string

saveTxOrder

boolean

compressionCodec

enum (YdsCompressionCodec)

  • YDS_COMPRESSION_CODEC_RAW
  • YDS_COMPRESSION_CODEC_GZIP
  • YDS_COMPRESSION_CODEC_ZSTD

serializer

Serializer

endpoint

string

subnetId

string

securityGroups[]

string

RuntimeRuntime

Field

Description

ycRuntime

YcRuntime

Includes only one of the fields ycRuntime.

YcRuntimeYcRuntime

Field

Description

jobCount

string (int64)

flavor

enum (Flavor)

  • SMALL
  • MEDIUM
  • LARGE
  • TINY

uploadShardParams

ShardingUploadParams

ShardingUploadParamsShardingUploadParams

Field

Description

jobCount

string (int64)

processCount

string (int64)

RegularSnapshotRegularSnapshot

Field

Description

settings

RegularSnapshotSettings

Includes only one of the fields settings, disabled.

disabled

object

Includes only one of the fields settings, disabled.

RegularSnapshotSettingsRegularSnapshotSettings

Field

Description

schedule

enum (RegularSnapshotScheduleInterval)

  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_15MIN
  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_30MIN
  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_HOUR
  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_2HOUR
  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_3HOUR
  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_6HOUR
  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_8HOUR
  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_12HOUR
  • REGULAR_SNAPSHOT_SCHEDULE_INTERVAL_DAY

tables[]

IncrementalTable

cronExpression

string

incrementDelaySeconds

string (int64)

retryConfig

RetryConfig

IncrementalTableIncrementalTable

Field

Description

tableNamespace

string

tableName

string

cursorColumn

string

initialState

string

RetryConfigRetryConfig

Field

Description

maxAttempts

string (int64)

TransformationTransformation

Field

Description

transformers[]

Transformer

TransformerTransformer

Field

Description

maskField

MaskFieldTransformer

Includes only one of the fields maskField, filterColumns, renameTables, replacePrimaryKey, convertToString, sharderTransformer, tableSplitterTransformer, filterRows.

filterColumns

FilterColumnsTransformer

Includes only one of the fields maskField, filterColumns, renameTables, replacePrimaryKey, convertToString, sharderTransformer, tableSplitterTransformer, filterRows.

renameTables

RenameTablesTransformer

Includes only one of the fields maskField, filterColumns, renameTables, replacePrimaryKey, convertToString, sharderTransformer, tableSplitterTransformer, filterRows.

replacePrimaryKey

ReplacePrimaryKeyTransformer

Includes only one of the fields maskField, filterColumns, renameTables, replacePrimaryKey, convertToString, sharderTransformer, tableSplitterTransformer, filterRows.

convertToString

ToStringTransformer

Includes only one of the fields maskField, filterColumns, renameTables, replacePrimaryKey, convertToString, sharderTransformer, tableSplitterTransformer, filterRows.

sharderTransformer

SharderTransformer

Includes only one of the fields maskField, filterColumns, renameTables, replacePrimaryKey, convertToString, sharderTransformer, tableSplitterTransformer, filterRows.

tableSplitterTransformer

TableSplitterTransformer

Includes only one of the fields maskField, filterColumns, renameTables, replacePrimaryKey, convertToString, sharderTransformer, tableSplitterTransformer, filterRows.

filterRows

FilterRowsTransformer

Includes only one of the fields maskField, filterColumns, renameTables, replacePrimaryKey, convertToString, sharderTransformer, tableSplitterTransformer, filterRows.

MaskFieldTransformerMaskFieldTransformer

Field

Description

tables

TablesFilter

columns[]

string

function

MaskFunction

TablesFilterTablesFilter

Field

Description

includeTables[]

string

excludeTables[]

string

MaskFunctionMaskFunction

Field

Description

maskFunctionHash

MaskFunctionHash

Includes only one of the fields maskFunctionHash.

MaskFunctionHashMaskFunctionHash

Field

Description

userDefinedSalt

string

FilterColumnsTransformerFilterColumnsTransformer

Field

Description

tables

TablesFilter

columns

ColumnsFilter

ColumnsFilterColumnsFilter

Field

Description

includeColumns[]

string

excludeColumns[]

string

RenameTablesTransformerRenameTablesTransformer

Field

Description

renameTables[]

RenameTable

RenameTableRenameTable

Field

Description

originalName

Table

newName

Table

TableTable

Field

Description

nameSpace

string

name

string

ReplacePrimaryKeyTransformerReplacePrimaryKeyTransformer

Field

Description

tables

TablesFilter

keys[]

string

ToStringTransformerToStringTransformer

Field

Description

tables

TablesFilter

columns

ColumnsFilter

skipUtcConversion

boolean

SharderTransformerSharderTransformer

Field

Description

columns

ColumnsFilter

Includes only one of the fields columns, random.

random

object

Includes only one of the fields columns, random.

tables

TablesFilter

shardsCount

string (int64)

TableSplitterTransformerTableSplitterTransformer

Field

Description

tables

TablesFilter

columns[]

string

splitter

string

FilterRowsTransformerFilterRowsTransformer

Field

Description

tables

TablesFilter

filter

string

filters[]

string

DataObjectsDataObjects

Field

Description

includeObjects[]

string

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

Предыдущая
UpdateYandexDataProcessing
Следующая
AddTablesToTransfer
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ООО «Яндекс.Облако»