Method: transferConfigs.patch

Full name: projects.locations.transferConfigs.patch

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

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The resource name of the transfer config. Transfer config names have the form projects/{projectId}/locations/{region}/transferConfigs/{configId}. Where configId is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

Query parameters



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

  • 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.

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".



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.



Optional service account name. If this field is set and "serviceAccountName" is set in updateMask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

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:


For more information, see the Authentication Overview.