REST 资源:projects.locations.dataSourceDefinitions

资源:DataSourceDefinition

表示数据源定义。

JSON 表示法

{
  "name": string,
  "dataSource": {
    object(DataSource)
  },
  "transferRunPubsubTopic": string,
  "runTimeOffset": string,
  "supportEmail": string,
  "serviceAccount": string,
  "disabled": boolean,
  "transferConfigPubsubTopic": string,
  "supportedLocationIds": [
    string
  ]
}
字段
name

string

数据源定义的资源名称。 数据源定义名称采用如下格式:projects/{projectId}/locations/{location}/dataSourceDefinitions/{dataSourceId}

dataSource

object(DataSource)

数据源元数据。

transferRunPubsubTopic

string

在创建转移作业运行时用于广播消息的 Pub/Sub 主题。此主题和 transferConfigPubsubTopic 均可设置为自定义主题。默认情况下,如果在创建定义时未提供这两个主题,则它们会自动生成。不过,如果其中一个主题是手动设置的,您还必须手动设置另一个主题。唯一的区别是 transferRunPubsubTopic 必须是非空的 Pub/Sub 主题,但 transferConfigPubsubTopic 可以留空。有关 transferConfigPubsubTopic 的“{location}”的评论在此处也同样适用。

runTimeOffset

string (Duration format)

应该添加到 scheduleTime 的持续时间,用于在安排作业时计算 runTime。仅适用于自动安排的传输运行。用于在支持连续数据刷新的数据源上提前启动运行,以补偿未知的时区偏移量。对于不支持连续数据刷新的数据源,请使用负数来延迟启动运行。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

supportEmail

string

支持 OAuth 客户端品牌的电子邮件地址,其中包含“同意”屏幕数据。

serviceAccount

string

指定服务帐号后,BigQuery 会与指定的服务帐号共享已创建的数据集。此外,此服务帐号将有权针对相应 dataSourceId 的数据转移作业运行执行状态更新和记录消息日志。

disabled

boolean

是否已停用数据源? 如果为 true,则无法看到数据源。此外,API 也会停止返回与数据源相关的任何数据转移作业配置和/或运行。此设置的优先级高于 whitelisted_project_ids。

transferConfigPubsubTopic

string

用于广播转移作业配置消息的 Pub/Sub 主题。如果留空,则不广播消息。如果在创建定义时未提供此主题和 transferRunPubsubTopic,则它们会自动生成。如果提供了用户拥有的 transferRunPubsubTopic,建议也提供 transferConfigPubsubTopic。否则,它将被留空。如果在值中发现“{location}”,则表示数据源希望为不同地区内的数据集单独处理消息。我们会将 {location} 替换为实际数据集位置,以作为实际主题名称。例如,projects/connector/topics/scheduler-{location} 可能会变为 projects/connector/topics/scheduler-us。如果未找到“{location}”,我们会将输入值用作主题名称。

supportedLocationIds[]

string

受支持的 location_ids,用于确定需要在哪些位置创建 Pub/Sub 主题。如果使用自定义 Pub/Sub 主题,并且它们包含“{location}”,则系统将使用 location_ids 来验证主题,方法是将“{location}”替换为列表中的单个位置。有效值是 GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations 的响应的“locationId”字段。此外,如果数据源需要支持所有可用地区,可以将 supportedLocationIds 设置为“global”(单个字符串元素)。指定“global”后:1) 数据源实现应该将数据暂存在目标数据集的适当地区;2) 数据源开发者应当了解支持“global”地区的影响(例如,网络流量延迟时间、与跨地区流量相关的潜在费用等)。

方法

create

创建数据源定义。

delete

要删除数据源定义,必须首先由所有地区中的用户删除与此数据源定义(如果有)相关的所有转移作业配置。

get

检索现有数据源定义。

list

列出支持的数据源定义。

patch

更新现有数据源定义。