CreateTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, authorization info must be provided. If authorization info is provided, the transfer configuration will be associated with the user id corresponding to the authorization info. Otherwise, the transfer configuration will be associated with the calling user.
Attributes |
|
|---|---|
| Name | Description |
parent |
str
Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. |
transfer_config |
google.cloud.bigquery_datatransfer_v1.types.TransferConfig
Required. Data transfer configuration to create. |
authorization_code |
str
Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it
is no longer used in any data sources. Use version_info
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 CheckValidCreds.
In order to obtain authorization_code, make a request to the
following URL:
.. raw:: html
https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
- The client_id is the OAuth client_id of the data source
as returned by ListDataSources method.
- data_source_scopes are the scopes returned by
ListDataSources method.
Note that this should not be set when
service_account_name is used to create the transfer
config.
|
version_info |
str
Optional version info. This parameter replaces authorization_code 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
CheckValidCreds. In order to obtain version info, make a
request to the following URL:
.. raw:: html
https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
- The client_id is the OAuth client_id of the data source
as returned by ListDataSources method.
- data_source_scopes are the scopes returned by
ListDataSources method.
Note that this should not be set when
service_account_name is used to create the transfer
config.
|
service_account_name |
str
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 |