BigQuery Data Transfer V1 Client - Class UpdateTransferConfigRequest (1.6.2)

Reference documentation and code samples for the BigQuery Data Transfer V1 Client class UpdateTransferConfigRequest.

A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.

Generated from protobuf message google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest

Namespace

Google \ Cloud \ BigQuery \ DataTransfer \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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 `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_name` is used to update the transfer config.
`↳ update_mask`	`Google\Protobuf\FieldMask` Required. Required list of fields to be updated in this request.
`↳ version_info`	`string` 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_name` is used to update the transfer config.
`↳ 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.

getTransferConfig

Required. Data transfer configuration to create.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig\|null`

hasTransferConfig

clearTransferConfig

setTransferConfig

Required. Data transfer configuration to create.

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_name is used to update the transfer config.

Returns
Type	Description
`string`

setAuthorizationCode

Optional OAuth2 authorization code to use with this transfer configuration.

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 update the transfer config.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUpdateMask

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

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

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

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

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_name is used to update the transfer config.

Returns
Type	Description
`string`

setVersionInfo

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

Returns
Type	Description
`string`

setServiceAccountName

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`transferConfig`	`Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig` Required. Data transfer configuration to create.
`updateMask`	`Google\Protobuf\FieldMask` Required. Required list of fields to be updated in this request.

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\UpdateTransferConfigRequest`