Method: transferConfigs.create

Full name: projects.locations.transferConfigs.create

Creates a new data transfer configuration.

HTTP request

POST https://bigquerydatatransfer.googleapis.com/v1/{parent=projects/*/locations/*}/transferConfigs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{projectId}/locations/{locationId} or projects/{projectId}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.transfers.update

Query parameters

Parameters
authorizationCode

string

Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by dataSources.checkValidCreds. 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.
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.
serviceAccountName

string

Optional service account name. If this field is set, transfer config will be created with 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 a newly created 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!