2.4.0 (latest) 2.3.3 2.2.4 2.1.5 2.0.0 1.8.6 1.7.0 1.6.2 1.5.2 1.4.5 1.3.8 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.
When using a cross project service account for creating a transfer config,
you must enable cross project service account usage. For more information,
see [Disable attachment of service accounts to resources in other
projects](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts).

Generated from protobuf message `google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest`

## Namespace

Google \\ Cloud \\ BigQuery \\ DataTransfer \\ V1

## 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` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.TransferConfig` Required. Data transfer configuration to create. |
| `↳ authorization_code` | `string` 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: ```php https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_idclient_id&scope=data_source_scopes ``` \* \* The <var translate="no">client_id</var> is the OAuth client_id of the data source as returned by ListDataSources method. \* \* <var translate="no">data_source_scopes</var> 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. <br /> |
| `↳ version_info` | `string` 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: ```php https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_idclient_id&scope=data_source_scopes ``` \* \* The <var translate="no">client_id</var> is the OAuth client_id of the data source as returned by ListDataSources method. \* \* <var translate="no">data_source_scopes</var> 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. <br /> |
| `↳ service_account_name` | `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](https://cloud.google.com/bigquery-transfer/docs/use-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.

| **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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTransferConfig

Required. Data transfer configuration to create.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.TransferConfig|null` |   |

### hasTransferConfig

### clearTransferConfig

### setTransferConfig

Required. Data transfer configuration to create.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.TransferConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAuthorizationCode

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:

```php
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 <var translate="no">client_id</var> is the OAuth client_id of the data source as returned by ListDataSources method.
- <var translate="no">data_source_scopes</var> 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setAuthorizationCode

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:

```php
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 <var translate="no">client_id</var> is the OAuth client_id of the data source as returned by ListDataSources method.
- <var translate="no">data_source_scopes</var> 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getVersionInfo

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:

```php
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 <var translate="no">client_id</var> is the OAuth client_id of the data source as
  returned by ListDataSources method.

- <var translate="no">data_source_scopes</var> 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setVersionInfo

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:

```php
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 <var translate="no">client_id</var> is the OAuth client_id of the data source as
  returned by ListDataSources method.

- <var translate="no">data_source_scopes</var> 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getServiceAccountName

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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setServiceAccountName

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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `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. Please see DataTransferServiceClient::projectName() for help formatting this field. |
| `transferConfig` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.TransferConfig` Required. Data transfer configuration to create. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquerydatatransfer/latest/V1.CreateTransferConfigRequest` |   |