资源:TransferConfig
该资源表示数据传输配置。转移作业配置包含执行数据转移作业所需的所有元数据。例如,destinationDatasetId
指定数据应存储在何处。创建新转移作业配置时,系统会根据需要创建指定的 destinationDatasetId
,并将其提供给相应的数据源服务帐号。
JSON 表示法 | |
---|---|
{
"name": string,
"destinationDatasetId": string,
"displayName": string,
"dataSourceId": string,
"params": {
object
},
"schedule": string,
"dataRefreshWindowDays": number,
"disabled": boolean,
"updateTime": string,
"nextRunTime": string,
"state": enum( |
字段 | |
---|---|
name |
转移作业配置的资源名称。转移作业配置名称采用 |
destinationDatasetId |
BigQuery 目标数据集 ID。 |
displayName |
用户为数据转移作业指定的显示名。 |
dataSourceId |
数据源 ID。 创建数据转移作业后,就无法再更改该 ID。 |
params |
特定于数据转移作业的参数。 |
schedule |
数据转移作业时间表。如果数据源不支持自定义时间表,则此字段应为空。如果此字段为空,系统会使用该数据源的默认值。指定的时间采用世界协调时间 (UTC)。有效格式的示例: |
dataRefreshWindowDays |
自动刷新数据时所对应的回溯天数。 例如,如果 |
disabled |
表示此配置是否处于停用状态。 如果设置为 true,则系统不会为指定转移作业安排任何运行。 |
updateTime |
仅供输出。数据传输修改时间。对于输入,服务器会忽略该项。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒。示例: |
nextRunTime |
仅供输出。数据传输的下次运行时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒。示例: |
state |
仅供输出。最近更新的转移作业运行的状态。 |
userId |
已弃用。用户的唯一 ID,转移作业由其他方代表该用户完成。 |
datasetRegion |
仅供输出。BigQuery 数据集所在的地区。 |
partnerToken |
用于标识存储在外部合作伙伴端的转移作业设置的唯一标识符。该令牌对于 DTS 来说是不透明的,只能由合作伙伴进行解释。合作伙伴数据源应在配置 ID 和该令牌之间创建映射,以验证转移作业配置/运行是否合法。 |
partnerConnectionInfo |
由合作伙伴数据源管理的转移作业设置。这些信息以键值对的形式存储,仅用于 DTS 界面显示目的。我们不想将它们与“params”参数存储在一起,原因有两个:- 连接信息由合作伙伴提供,且在 DTS 界面中不可修改,这与不可变参数不同。通过将不同的布尔值添加到 DataSourceParameter 来区分它们会令人困惑。- 连接信息可以是任意键值对。如果要将这些参数添加到 params 字段中,合作伙伴必须在数据源定义中为它们提供定义。为合作伙伴免去这一操作会更友好。 |
方法 |
|
---|---|
|
创建新的数据转移作业配置。 |
|
删除数据转移作业配置,包括任何关联的转移作业运行和日志。 |
|
返回有关数据转移作业配置的信息。 |
|
返回有关项目中所有数据转移作业的信息。 |
|
更新数据转移作业配置。 |
|
为某个时间范围 [start_time, end_time] 创建转移作业运行。 |