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

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
transferConfig.name

string

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{projectId}/locations/{region}/transferConfigs/{configId} or projects/{projectId}/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

Parameters
authorizationCode
(deprecated)

string

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use versionInfo instead.

Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by dataSources.checkValidCreds. In order to obtain authorizationCode, make a request to the following URL:

https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=clientId&scope=data_source_scopes
  • The clientId is the OAuth clientId of the data source as returned by dataSources.list method.
  • data_source_scopes are the scopes returned by dataSources.list method.

Note that this should not be set when serviceAccountName is used to update the transfer config.
updateMask

string (FieldMask format)

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

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
versionInfo

string

Optional version info. This parameter replaces authorizationCode which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or new credentials are needed, as indicated by dataSources.checkValidCreds. In order to obtain version info, make a request to the following URL:

https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=clientId&scope=data_source_scopes
  • The clientId is the OAuth clientId of the data source as returned by dataSources.list method.
  • data_source_scopes are the scopes returned by dataSources.list method.

Note that this should not be set when serviceAccountName is used to update the transfer config.
serviceAccountName

string

Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account.

Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.

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.