REST 资源:projects.locations.dataSources

资源:DataSource

表示数据源元数据。元数据足以呈现界面并请求合适的 OAuth 令牌。

JSON 表示法

{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum (TransferType),
  "supportsMultipleTransfers": boolean,
  "updateDeadlineSeconds": integer,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum (AuthorizationType),
  "dataRefreshType": enum (DataRefreshType),
  "defaultDataRefreshWindowDays": integer,
  "manualRunsDisabled": boolean,
  "minimumScheduleInterval": string
}
字段
name

string

仅供输出。数据源资源名称。

dataSourceId

string

数据源 ID。

displayName

string

方便用户使用的数据源名称。

description

string

方便用户使用的数据源说明字符串。

clientId

string

应该用于接收刷新令牌的数据源客户端 ID。

scopes[]

string

需要为之获取刷新令牌的 API 身份验证范围。 要了解数据源准备数据和将数据提取到 BigQuery 中时所需的范围示例,请访问 https://www.googleapis.com/auth/bigquery

transferType
(deprecated)

enum (TransferType)

已弃用。此字段无效。

supportsMultipleTransfers
(deprecated)

boolean

已弃用。此字段无效。

updateDeadlineSeconds

integer

在 Data Transfer Service 将转移作业标记为 FAILED 之前等待数据源进行更新的秒数。

defaultSchedule

string

默认的数据转移作业时间表。有效时间表的示例包括 1st,3rd monday of month 15:30every wed,fri of jan,jun 13:15first sunday of quarter 00:00

supportsCustomSchedule

boolean

用于指定数据源是支持用户指定的时间表还是依照默认时间表运行。 如果设置为 true,则用户可以覆盖默认时间表。

parameters[]

object (DataSourceParameter)

数据源参数。

helpUrl

string

此数据源的帮助文档的网址。

authorizationType

enum (AuthorizationType)

表示授权类型。

dataRefreshType

enum (DataRefreshType)

指定数据源是否支持自动刷新过去几天的数据以及如何支持。 对于某些数据源,数据可能要在几天后才能完成转移,因此自动刷新数据非常有用。

defaultDataRefreshWindowDays

integer

默认的数据刷新时段(以天为单位)。 仅在 dataRefreshType = SLIDING_WINDOW 时才有意义。

manualRunsDisabled

boolean

停用数据源的回填和手动运行时间表。

minimumScheduleInterval

string (Duration format)

调度器安排运行的最小间隔。

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

方法

checkValidCreds

如果指定数据源和发出请求的用户拥有有效凭据,则返回 true。

get

检索受支持的数据源并返回其设置,这些设置可用于界面呈现。

list

列出受支持的数据源并返回其设置,该设置可用于呈现界面。