REST 资源:projects.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"

TransferType

已弃用。表示数据转移作业类型。

枚举
TRANSFER_TYPE_UNSPECIFIED 无效或未知的传输类型占位符。
BATCH 批量数据传输。
STREAMING 流式数据传输。流式传输数据源当前不支持每个项目具有多个传输配置。

DataSourceParameter

表示具有验证规则的数据源参数,以便可以在界面中呈现参数。这些参数由支持的数据源提供给我们,并且包括用于呈现和验证的所有需要的信息。因此,使用此 API 的用户可以决定生成常规界面或自定义特定于数据源的表单。

JSON 表示法

{
  "paramId": string,
  "displayName": string,
  "description": string,
  "type": enum (Type),
  "required": boolean,
  "repeated": boolean,
  "validationRegex": string,
  "allowedValues": [
    string
  ],
  "minValue": number,
  "maxValue": number,
  "fields": [
    {
      object (DataSourceParameter)
    }
  ],
  "validationDescription": string,
  "validationHelpUrl": string,
  "immutable": boolean,
  "recurse": boolean,
  "deprecated": boolean
}
字段
paramId

string

参数标识符。

displayName

string

界面中的参数显示名称。

description

string

参数说明。

type

enum (Type)

参数类型。

required

boolean

是否需要参数。

repeated

boolean

已弃用。此字段无效。

validationRegex

string

可用于参数验证的正则表达式。

allowedValues[]

string

参数的所有可能值。

minValue

number

对于整数和双精度值,指定允许的最小值。

maxValue

number

对于整数和双精度值,指定允许的最大值。

fields[]

object (DataSourceParameter)

已弃用。此字段无效。

validationDescription

string

此字段要求的说明(如果用户输入不满足正则表达式格式或最小/最大值)。

validationHelpUrl

string

进一步说明命名要求的帮助文档的网址。

immutable

boolean

初始创建后便无法更改。

recurse

boolean

已弃用。此字段无效。

deprecated

boolean

如果为 true,则新的转移作业中不应使用此字段,用户也不应看到此字段。

类型

参数类型。

枚举
TYPE_UNSPECIFIED 未指定类型。
STRING 字符串参数。
INTEGER 整数参数(64 位)。此参数会序列化为 json 字符串。
DOUBLE 双精度浮点参数。
BOOLEAN 布尔值参数。
RECORD 已弃用。此字段无效。
PLUS_PAGE Google+ 信息页的页面 ID。

AuthorizationType

此数据源所需的授权类型。

枚举
AUTHORIZATION_TYPE_UNSPECIFIED 未指定类型。
AUTHORIZATION_CODE 使用可以在后端交换刷新令牌的 OAuth 2 授权代码。
GOOGLE_PLUS_AUTHORIZATION_CODE 返回给定 Google+ 信息页的授权代码,然后可以在后端将其用于交换刷新令牌。
FIRST_PARTY_OAUTH 使用基于 Loas 自有客户端的第一方 OAuth。第一方 OAuth 无需刷新令牌即可获取离线访问令牌。相反,它使用客户端签名的 JWT 断言来检索访问令牌。

DataRefreshType

表示数据源如何支持数据自动刷新。

枚举
DATA_REFRESH_TYPE_UNSPECIFIED 数据源不支持数据自动刷新,这是默认值。
SLIDING_WINDOW 数据源支持数据自动刷新,并且将安排针对过去几天的运行。不允许为每个传输配置设置自定义值。
CUSTOM_SLIDING_WINDOW 数据源支持数据自动刷新,并且将安排针对过去几天的运行。允许为每个传输配置设置自定义值。

方法

checkValidCreds

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

get

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

list

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