Method: projects.transferConfigs.patch

Updates a data transfer configuration. All fields must be set, even if they are not updated.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
transferConfig.name

string

The resource name of the transfer config. Transfer config names have the form of projects/{projectId}/locations/{region}/transferConfigs/{configId}. The name is automatically generated based on the configId specified in CreateTransferConfigRequest along with projectId and region. If configId is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for configId.

Query parameters

Parameters
authorizationCode

string

Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorizationCode, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?clientId=&scope=&redirect_uri=

  • clientId should be OAuth clientId of BigQuery DTS API for the given data source returned by dataSources.list method.
  • data_source_scopes are the scopes returned by dataSources.list method.
  • redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

updateMask

string (FieldMask format)

Required. Required list of fields to be updated in this request.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

versionInfo

string

Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the versionInfo claim in the token request. To obtain the versionInfo, users must use the "none+gsession" response type. which be return a versionInfo back in the authorization response which be be put in a JWT claim in the token request.

Request body

The request body contains an instance of TransferConfig.

Response body

If successful, the response body contains an instance of TransferConfig.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Try it!

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
BigQuery Data Transfer Service