Reference documentation and code samples for the BigQuery Data Transfer V1 Client class CreateTransferConfigRequest.
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.
Generated from protobuf message google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
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\TransferConfig
Required. Data transfer configuration to create. |
↳ authorization_code |
string
Optional OAuth2 authorization code to use with this transfer configuration. This is required only if https://www.gstatic.com/bigquerydatatransfer/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 a 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 |
string
Optional version info. This is required only if https://www.gstatic.com/bigquerydatatransfer/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 a 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 |
string
Optional service account name. 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. |
getParent
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.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
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.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTransferConfig
Required. Data transfer configuration to create.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig|null | |
hasTransferConfig
clearTransferConfig
setTransferConfig
Required. Data transfer configuration to create.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAuthorizationCode
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:
https://www.gstatic.com/bigquerydatatransfer/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 a 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_nameis used to create the transfer config.
Generated from protobuf field string authorization_code = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setAuthorizationCode
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:
https://www.gstatic.com/bigquerydatatransfer/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 a 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_nameis used to create the transfer config.
Generated from protobuf field string authorization_code = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVersionInfo
Optional version info. This is required only if
transferConfig.dataSourceId is not 'youtube_channel' and new credentials
are needed, as indicated by CheckValidCreds. In order to obtain version
info, make a request to the following URL:
https://www.gstatic.com/bigquerydatatransfer/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 a 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_nameis used to create the transfer config.
Generated from protobuf field string version_info = 5;
| Returns | |
|---|---|
| Type | Description |
string | |
setVersionInfo
Optional version info. This is required only if
transferConfig.dataSourceId is not 'youtube_channel' and new credentials
are needed, as indicated by CheckValidCreds. In order to obtain version
info, make a request to the following URL:
https://www.gstatic.com/bigquerydatatransfer/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 a 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_nameis used to create the transfer config.
Generated from protobuf field string version_info = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceAccountName
Optional service account name. 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.
Generated from protobuf field string service_account_name = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setServiceAccountName
Optional service account name. 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.
Generated from protobuf field string service_account_name = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |