方法：transferConfigs.patch

全名：projects.locations.transferConfigs.patch

更新数据转移作业配置。必须设置所有字段（即使这些字段未更新）。

HTTP 请求

PATCH https://bigquerydatatransfer.googleapis.com/v1/{transferConfig.name=projects/*/locations/*/transferConfigs/*}

网址采用 gRPC 转码语法。

路径参数

参数
transferConfig.name

string

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

查询参数

参数
authorizationCode

string

要在此传输配置中使用的 OAuth2 授权代码（可选）。如果提供该授权代码，则转移作业配置将与授权用户相关联。要获取 authorizationCode，请向以下链接所指向的网页发出请求：https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?clientId=&scope=&redirect_uri=

  • clientId 应是适用于指定数据源（由 dataSources.list 方法返回）的 BigQuery DTS API 的 OAuth clientId。
  • data_source_scopes 是 dataSources.list 方法返回的范围。
  • redirect_uri 是可选参数。如果未指定该参数，则授权代码会发布至授权流窗口的开启者。否则，它将发送到重定向 URI。urn:ietf:wg:oauth:2.0:oob 这个特殊值表示应在浏览器的标题栏中返回授权代码，同时在页面上显示文字，提示用户复制该代码并将其粘贴到应用中。
updateMask

string (FieldMask format)

必需。要在此请求中更新的必填字段列表。

以英文逗号分隔的完全限定字段名称列表。示例："user.displayName,photo"。
versionInfo

string

可选的版本信息。如果用户希望查找最新的访问令牌（即紧随批准访问权限之后），则必须在令牌请求中设置 versionInfo 声明。为了获取 versionInfo，用户必须使用“none+gsession”响应类型，该类型会在授权响应中返回 versionInfo，后者将置于令牌请求的 JWT 声明中。
serviceAccountName

string

可选的服务帐号名称。如果设置了此字段并且在 updateMask 中设置了“serviceAccountName”，则转移作业配置将更新以使用此服务帐号凭据。调用此 API 的请求用户必须拥有以此服务帐号的身份执行操作的权限。

请求正文

请求正文包含一个 TransferConfig 实例。

响应正文

如果成功，则响应正文包含一个 TransferConfig 实例。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。

试试看！