Data Transfer Audit Trails Events: ActivateTransfer
- 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 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 description
|
Field |
Description |
|
eventId |
string |
|
eventSource |
string |
|
eventType |
string |
|
eventTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
|
authentication |
|
|
authorization |
|
|
resourceMetadata |
|
|
requestMetadata |
|
|
eventStatus |
enum (EventStatus)
|
|
error |
The error result of the operation in case of failure or cancellation. |
|
details |
|
|
requestParameters |
object |
|
response |
object |
IamAuthentication
|
Field |
Description |
|
authenticated |
boolean |
|
subjectType |
enum (IamSubjectType) Includes only one of the fields
|
|
subjectId |
string Includes only one of the fields |
|
subjectName |
string Includes only one of the fields |
|
federationId |
string Includes only one of the fields |
|
federationName |
string Includes only one of the fields |
|
federationType |
enum (FederationType) Includes only one of the fields
|
|
tokenInfo |
IamTokenInfo
|
Field |
Description |
|
maskedIamToken |
string |
|
iamTokenId |
string Includes only one of the fields |
|
impersonatorId |
string Includes only one of the fields |
|
impersonatorType |
enum (IamSubjectType) Includes only one of the fields
|
|
impersonatorName |
string Includes only one of the fields |
|
impersonatorFederationId |
string Includes only one of the fields |
|
impersonatorFederationName |
string Includes only one of the fields |
|
impersonatorFederationType |
enum (FederationType) Includes only one of the fields
|
Authorization
|
Field |
Description |
|
authorized |
boolean |
ResourceMetadata
|
Field |
Description |
|
path[] |
Resource
|
Field |
Description |
|
resourceType |
string |
|
resourceId |
string |
|
resourceName |
string Includes only one of the fields |
RequestMetadata
|
Field |
Description |
|
remoteAddress |
string |
|
userAgent |
string |
|
requestId |
string |
|
remotePort |
string (int64) Includes only one of the fields |
Status
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. |
TransferEventDetails
|
Field |
Description |
|
transferId |
string The maximum string length in characters is 50. |
|
transferName |
string |
|
transfer |
Transfer
|
Field |
Description |
|
id |
string |
|
folderId |
string |
|
name |
string |
|
description |
string |
|
labels |
object (map<string, string>) |
|
source |
|
|
target |
|
|
runtime |
|
|
status |
enum (TransferStatus)
|
|
type |
enum (TransferType)
|
|
warning |
string |
|
regularSnapshot |
|
|
transformation |
|
|
dataObjects |
|
|
prestable |
boolean |
|
replicationRuntime |
Endpoint
|
Field |
Description |
|
id |
string |
|
folderId |
string |
|
name |
string |
|
description |
string |
|
labels |
object (map<string, string>) |
|
settings |
EndpointSettings
|
Field |
Description |
|
mysqlSource |
Includes only one of the fields |
|
postgresSource |
Includes only one of the fields |
|
ydbSource |
Includes only one of the fields |
|
ydsSource |
Includes only one of the fields |
|
kafkaSource |
Includes only one of the fields |
|
mongoSource |
Includes only one of the fields |
|
clickhouseSource |
Includes only one of the fields |
|
mysqlTarget |
Includes only one of the fields |
|
postgresTarget |
Includes only one of the fields |
|
clickhouseTarget |
Includes only one of the fields |
|
ydbTarget |
Includes only one of the fields |
|
kafkaTarget |
Includes only one of the fields |
|
mongoTarget |
Includes only one of the fields |
|
metrikaSource |
Includes only one of the fields |
|
ydsTarget |
Includes only one of the fields |
MysqlSource
|
Field |
Description |
|
connection |
|
|
database |
string |
|
user |
string |
|
password |
|
|
timezone |
string |
|
objectTransferSettings |
|
|
includeTablesRegex[] |
string |
|
excludeTablesRegex[] |
string |
|
securityGroups[] |
string |
|
serviceDatabase |
string |
MysqlConnection
|
Field |
Description |
|
mdbClusterId |
string Includes only one of the fields |
|
onPremise |
Includes only one of the fields |
|
connectionManagerConnection |
Includes only one of the fields |
OnPremiseMysql
|
Field |
Description |
|
port |
string (int64) |
|
subnetId |
string |
|
hosts[] |
string |
|
tlsMode |
TLSMode
|
Field |
Description |
|
enabled |
Includes only one of the fields |
TLSConfig
|
Field |
Description |
|
caCertificate |
string |
ConnectionManagerConnection
|
Field |
Description |
|
connectionId |
string |
|
subnetId |
string |
Secret
|
Field |
Description |
|
raw |
string Includes only one of the fields |
MysqlObjectTransferSettings
|
Field |
Description |
|
view |
enum (ObjectTransferStage)
|
|
routine |
enum (ObjectTransferStage)
|
|
trigger |
enum (ObjectTransferStage)
|
|
tables |
enum (ObjectTransferStage)
|
PostgresSource
|
Field |
Description |
|
connection |
|
|
database |
string |
|
user |
string |
|
password |
|
|
includeTables[] |
string |
|
excludeTables[] |
string |
|
slotByteLagLimit |
string (int64) |
|
serviceSchema |
string |
|
objectTransferSettings |
|
|
securityGroups[] |
string |
PostgresConnection
|
Field |
Description |
|
mdbClusterId |
string Includes only one of the fields |
|
onPremise |
Includes only one of the fields |
|
connectionManagerConnection |
Includes only one of the fields |
OnPremisePostgres
|
Field |
Description |
|
port |
string (int64) |
|
subnetId |
string |
|
hosts[] |
string |
|
tlsMode |
PostgresObjectTransferSettings
|
Field |
Description |
|
sequence |
enum (ObjectTransferStage)
|
|
sequenceOwnedBy |
enum (ObjectTransferStage)
|
|
table |
enum (ObjectTransferStage)
|
|
primaryKey |
enum (ObjectTransferStage)
|
|
fkConstraint |
enum (ObjectTransferStage)
|
|
defaultValues |
enum (ObjectTransferStage)
|
|
constraint |
enum (ObjectTransferStage)
|
|
index |
enum (ObjectTransferStage)
|
|
view |
enum (ObjectTransferStage)
|
|
function |
enum (ObjectTransferStage)
|
|
trigger |
enum (ObjectTransferStage)
|
|
type |
enum (ObjectTransferStage)
|
|
rule |
enum (ObjectTransferStage)
|
|
collation |
enum (ObjectTransferStage)
|
|
policy |
enum (ObjectTransferStage)
|
|
cast |
enum (ObjectTransferStage)
|
|
materializedView |
enum (ObjectTransferStage)
|
|
sequenceSet |
enum (ObjectTransferStage)
|
YdbSource
|
Field |
Description |
|
database |
string |
|
instance |
string |
|
paths[] |
string |
|
serviceAccountId |
string |
|
subnetId |
string |
|
saKeyContent |
string |
|
securityGroups[] |
string |
|
changefeedCustomName |
string |
|
changefeedCustomConsumerName |
string |
YDSSource
|
Field |
Description |
|
database |
string |
|
stream |
string |
|
serviceAccountId |
string |
|
supportedCodecs[] |
enum (YdsCompressionCodec)
|
|
parser |
|
|
allowTtlRewind |
boolean |
|
endpoint |
string |
|
subnetId |
string |
|
securityGroups[] |
string |
|
consumer |
string |
Parser
|
Field |
Description |
|
jsonParser |
Includes only one of the fields |
|
auditTrailsV1Parser |
object Includes only one of the fields |
|
cloudLoggingParser |
object Includes only one of the fields |
|
tskvParser |
Includes only one of the fields |
GenericParserCommon
|
Field |
Description |
|
dataSchema |
|
|
nullKeysAllowed |
boolean |
|
addRestColumn |
boolean |
|
unescapeStringValues |
boolean |
DataSchema
|
Field |
Description |
|
jsonFields |
string Includes only one of the fields |
|
fields |
Includes only one of the fields |
FieldList
|
Field |
Description |
|
fields[] |
ColSchema
|
Field |
Description |
|
name |
string |
|
type |
enum (ColumnType)
|
|
key |
boolean |
|
required |
boolean |
|
path |
string |
KafkaSource
|
Field |
Description |
|
connection |
|
|
auth |
|
|
securityGroups[] |
string |
|
topicName |
string |
|
transformer |
|
|
parser |
|
|
topicNames[] |
string |
KafkaConnectionOptions
|
Field |
Description |
|
clusterId |
string Includes only one of the fields |
|
onPremise |
Includes only one of the fields |
|
connectionManagerConnection |
Includes only one of the fields |
OnPremiseKafka
|
Field |
Description |
|
brokerUrls[] |
string |
|
subnetId |
string |
|
tlsMode |
KafkaAuth
|
Field |
Description |
|
sasl |
Includes only one of the fields |
|
noAuth |
object Includes only one of the fields |
KafkaSaslSecurity
|
Field |
Description |
|
user |
string |
|
mechanism |
enum (KafkaMechanism)
|
|
password |
DataTransformationOptions
|
Field |
Description |
|
cloudFunction |
string |
|
numberOfRetries |
string (int64) |
|
bufferSize |
string |
|
bufferFlushInterval |
string |
|
invocationTimeout |
string |
|
serviceAccountId |
string |
MongoSource
|
Field |
Description |
|
connection |
|
|
subnetId |
string |
|
collections[] |
|
|
excludedCollections[] |
|
|
secondaryPreferredMode |
boolean |
|
securityGroups[] |
string |
MongoConnection
|
Field |
Description |
|
connectionOptions |
Includes only one of the fields |
MongoConnectionOptions
|
Field |
Description |
|
mdbClusterId |
string Includes only one of the fields |
|
onPremise |
Includes only one of the fields |
|
connectionManagerConnection |
MongoConnectionManagerConnection Includes only one of the fields |
|
user |
string |
|
password |
|
|
authSource |
string |
OnPremiseMongo
|
Field |
Description |
|
hosts[] |
string |
|
port |
string (int64) |
|
replicaSet |
string |
|
tlsMode |
MongoConnectionManagerConnection
|
Field |
Description |
|
connectionId |
string |
|
replicaSet |
string |
MongoCollection
|
Field |
Description |
|
databaseName |
string |
|
collectionName |
string |
ClickhouseSource
|
Field |
Description |
|
connection |
|
|
includeTables[] |
string |
|
excludeTables[] |
string |
|
subnetId |
string |
|
securityGroups[] |
string |
|
clickhouseClusterName |
string |
ClickhouseConnection
|
Field |
Description |
|
connectionOptions |
Includes only one of the fields |
ClickhouseConnectionOptions
|
Field |
Description |
|
onPremise |
Includes only one of the fields |
|
connectionManagerConnection |
Includes only one of the fields |
|
mdbClusterId |
string Includes only one of the fields |
|
user |
string |
|
password |
|
|
database |
string |
OnPremiseClickhouse
|
Field |
Description |
|
shards[] |
|
|
httpPort |
string (int64) |
|
nativePort |
string (int64) |
|
tlsMode |
ClickhouseShard
|
Field |
Description |
|
name |
string |
|
hosts[] |
string |
MysqlTarget
|
Field |
Description |
|
connection |
|
|
database |
string |
|
user |
string |
|
password |
|
|
sqlMode |
string |
|
skipConstraintChecks |
boolean |
|
timezone |
string |
|
cleanupPolicy |
enum (CleanupPolicy)
|
|
serviceDatabase |
string |
|
securityGroups[] |
string |
|
isSchemaMigrationDisabled |
boolean |
PostgresTarget
|
Field |
Description |
|
connection |
|
|
database |
string |
|
user |
string |
|
password |
|
|
cleanupPolicy |
enum (CleanupPolicy)
|
|
securityGroups[] |
string |
|
isSchemaMigrationDisabled |
boolean |
ClickhouseTarget
|
Field |
Description |
|
connection |
|
|
subnetId |
string |
|
altNames[] |
|
|
cleanupPolicy |
enum (ClickhouseCleanupPolicy)
|
|
sharding |
|
|
isSchemaMigrationDisabled |
boolean |
|
clickhouseClusterName |
string |
|
securityGroups[] |
string |
AltName
|
Field |
Description |
|
fromName |
string |
|
toName |
string |
ClickhouseSharding
|
Field |
Description |
|
columnValueHash |
Includes only one of the fields |
|
customMapping |
Includes only one of the fields |
ColumnValueHash
|
Field |
Description |
|
columnName |
string |
ColumnValueMapping
|
Field |
Description |
|
columnName |
string |
|
mapping[] |
ValueToShard
|
Field |
Description |
|
columnValue |
|
|
shardName |
string |
ColumnValue
|
Field |
Description |
|
stringValue |
string Includes only one of the fields |
YdbTarget
|
Field |
Description |
|
database |
string |
|
instance |
string |
|
path |
string |
|
serviceAccountId |
string |
|
cleanupPolicy |
enum (YdbCleanupPolicy)
|
|
subnetId |
string |
|
saKeyContent |
string |
|
securityGroups[] |
string |
|
isTableColumnOriented |
boolean |
|
defaultCompression |
enum (YdbDefaultCompression)
|
|
isSchemaMigrationDisabled |
boolean |
KafkaTarget
|
Field |
Description |
|
connection |
|
|
auth |
|
|
securityGroups[] |
string |
|
topicSettings |
|
|
serializer |
KafkaTargetTopicSettings
|
Field |
Description |
|
topic |
Includes only one of the fields |
|
topicPrefix |
string Includes only one of the fields |
KafkaTargetTopic
|
Field |
Description |
|
topicName |
string |
|
saveTxOrder |
boolean |
Serializer
|
Field |
Description |
|
serializerAuto |
object Includes only one of the fields |
|
serializerJson |
object Includes only one of the fields |
|
serializerDebezium |
Includes only one of the fields |
SerializerDebezium
|
Field |
Description |
|
serializerParameters[] |
DebeziumSerializerParameter
|
Field |
Description |
|
key |
string |
|
value |
string |
MongoTarget
|
Field |
Description |
|
connection |
|
|
database |
string |
|
cleanupPolicy |
enum (CleanupPolicy)
|
|
subnetId |
string |
|
securityGroups[] |
string |
MetrikaSource
|
Field |
Description |
|
counterIds[] |
string (int64) |
|
token |
|
|
streams[] |
MetrikaStream
|
Field |
Description |
|
type |
enum (MetrikaStreamType)
|
|
columns[] |
string |
YDSTarget
|
Field |
Description |
|
database |
string |
|
stream |
string |
|
serviceAccountId |
string |
|
saveTxOrder |
boolean |
|
compressionCodec |
enum (YdsCompressionCodec)
|
|
serializer |
|
|
endpoint |
string |
|
subnetId |
string |
|
securityGroups[] |
string |
Runtime
|
Field |
Description |
|
ycRuntime |
Includes only one of the fields |
YcRuntime
|
Field |
Description |
|
jobCount |
string (int64) |
|
flavor |
enum (Flavor)
|
|
uploadShardParams |
ShardingUploadParams
|
Field |
Description |
|
jobCount |
string (int64) |
|
processCount |
string (int64) |
RegularSnapshot
|
Field |
Description |
|
settings |
Includes only one of the fields |
|
disabled |
object Includes only one of the fields |
RegularSnapshotSettings
|
Field |
Description |
|
schedule |
enum (RegularSnapshotScheduleInterval)
|
|
tables[] |
|
|
cronExpression |
string |
|
incrementDelaySeconds |
string (int64) |
|
retryConfig |
IncrementalTable
|
Field |
Description |
|
tableNamespace |
string |
|
tableName |
string |
|
cursorColumn |
string |
|
initialState |
string |
RetryConfig
|
Field |
Description |
|
maxAttempts |
string (int64) |
Transformation
|
Field |
Description |
|
transformers[] |
Transformer
|
Field |
Description |
|
maskField |
Includes only one of the fields |
|
filterColumns |
Includes only one of the fields |
|
renameTables |
Includes only one of the fields |
|
replacePrimaryKey |
Includes only one of the fields |
|
convertToString |
Includes only one of the fields |
|
sharderTransformer |
Includes only one of the fields |
|
tableSplitterTransformer |
Includes only one of the fields |
|
filterRows |
Includes only one of the fields |
MaskFieldTransformer
|
Field |
Description |
|
tables |
|
|
columns[] |
string |
|
function |
TablesFilter
|
Field |
Description |
|
includeTables[] |
string |
|
excludeTables[] |
string |
MaskFunction
|
Field |
Description |
|
maskFunctionHash |
Includes only one of the fields |
MaskFunctionHash
|
Field |
Description |
|
userDefinedSalt |
string |
FilterColumnsTransformer
|
Field |
Description |
|
tables |
|
|
columns |
ColumnsFilter
|
Field |
Description |
|
includeColumns[] |
string |
|
excludeColumns[] |
string |
RenameTablesTransformer
|
Field |
Description |
|
renameTables[] |
RenameTable
|
Field |
Description |
|
originalName |
|
|
newName |
Table
|
Field |
Description |
|
nameSpace |
string |
|
name |
string |
ReplacePrimaryKeyTransformer
|
Field |
Description |
|
tables |
|
|
keys[] |
string |
ToStringTransformer
|
Field |
Description |
|
tables |
|
|
columns |
|
|
skipUtcConversion |
boolean |
SharderTransformer
|
Field |
Description |
|
columns |
Includes only one of the fields |
|
random |
object Includes only one of the fields |
|
tables |
|
|
shardsCount |
string (int64) |
TableSplitterTransformer
|
Field |
Description |
|
tables |
|
|
columns[] |
string |
|
splitter |
string |
FilterRowsTransformer
|
Field |
Description |
|
tables |
|
|
filter |
string |
|
filters[] |
string |
DataObjects
|
Field |
Description |
|
includeObjects[] |
string |