REST 资源：projects.locations.transferConfigs

资源：TransferConfig

该资源表示数据传输配置。转移作业配置包含执行数据转移作业所需的所有元数据。例如，destinationDatasetId 指定数据应存储在何处。创建新转移作业配置时，系统会根据需要创建指定的 destinationDatasetId，并将其提供给相应的数据源服务帐号。

JSON 表示法 

{
  "name": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "scheduleOptions": {
    object (ScheduleOptions)
  },
  "dataRefreshWindowDays": integer,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum (TransferState),
  "userId": string,
  "datasetRegion": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
字段
name

string

转移作业配置的资源名称。转移作业配置名称采用 projects/{projectId}/locations/{region}/transferConfigs/{configId} 格式。该名称是系统根据 CreateTransferConfigRequest 中指定的 configId 以及 projectId 和地区自动生成的。如果未提供 configId，则系统通常会为 configId 生成一个 uuid，即使不一定生成或者不需要该 uuid 也是如此。
displayName

string

用户为数据转移作业指定的显示名。
dataSourceId

string

数据源 ID。 创建数据转移作业后，就无法再更改该 ID。
params

object (Struct format)

特定于数据转移作业的参数。
schedule

string

数据转移作业时间表。如果数据源不支持自定义时间表，则此字段应为空。如果此字段为空，系统会使用该数据源的默认值。指定的时间采用世界协调时间 (UTC)。有效格式的示例：1st,3rd monday of month 15:30、every wed,fri of jan,jun 13:15、first sunday of quarter 00:00。请点击以下链接，查看有关该格式的更多说明：https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format。注意：时间粒度至少应为 8 小时或更低频率。
scheduleOptions

object (ScheduleOptions)

自定义数据转移作业时间表的选项。
dataRefreshWindowDays

integer

自动刷新数据时所对应的回溯天数。 例如，如果 dataRefreshWindowDays = 10，BigQuery 每天会重新提取 [today-10, today-1] 的数据，而不是仅提取 [today-1] 的数据。仅在数据源支持该功能时有效。将该值设为 0 可使用默认值。
disabled

boolean

表示此配置是否处于停用状态。 如果设置为 true，则系统不会为指定转移作业安排任何运行。
updateTime

string (Timestamp format)

仅供输出。数据传输修改时间。对于输入，服务器会忽略该项。
nextRunTime

string (Timestamp format)

仅供输出。数据转移作业的下次运行时间。
state

enum (TransferState)

仅供输出。最近更新的转移作业运行的状态。
userId

string (int64 format)

已弃用。用户的唯一 ID，转移作业由其他方代表该用户完成。
datasetRegion

string

仅供输出。BigQuery 数据集所在的地区。
notificationPubsubTopic

string

Pub/Sub 主题，系统将在与此转移作业配置关联的转移作业运行完成后通过该主题发送通知。
emailPreferences

object (EmailPreferences)

电子邮件通知将根据这些偏好设置发送到拥有此转移作业配置的用户的电子邮件地址。
destinationDatasetId

string

BigQuery 目标数据集 ID。

ScheduleOptions

自定义数据转移作业时间表的选项。

JSON 表示法 

{
  "disableAutoScheduling": boolean,
  "startTime": string,
  "endTime": string
}
字段
disableAutoScheduling

boolean

如果为 true，则系统不会为此配置自动安排数据转移作业运行。您可以使用 transferConfigs.startManualRuns API 临时启动运行。如果停用自动安排功能，则系统将忽略 TransferConfig.schedule 字段。
startTime

string (Timestamp format)

指定开始安排转移作业运行的时间。系统将根据时间表字符串中定义的定期重复模式在开始时间或之后安排第一次运行。开始时间可以随时更改。可以手动触发数据转移作业的时间不受此选项的限制。
endTime

string (Timestamp format)

定义停止安排转移作业运行的时间。转移作业运行不能安排在结束时间或之后。结束时间可以随时更改。可以手动触发数据转移作业的时间不受此选项的限制。

方法

create

 创建新的数据转移作业配置。

delete

 删除数据转移作业配置，包括任何关联的转移作业运行和日志。

get

 返回有关数据转移作业配置的信息。

list

 返回有关项目中所有数据转移作业的信息。

patch

 更新数据转移作业配置。

scheduleRuns
(deprecated)

 为某个时间范围 [start_time, end_time] 创建转移作业运行。

startManualRuns

 现在开始手动执行转移作业运行，其 schedule_time 等于当前时间。