Method: projects.locations.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/*/locations/*/transferConfigs/*}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
transferConfig.name

string

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

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 gaia id of 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 list of fields to be updated in this request.

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

Request body

The request body contains an instance of TransferConfig.

Response body

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

Authorization

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

Try it!

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...