Google BigQuery Data Transfer v1 API - Class UpdateTransferConfigRequest (4.10.0) 

public sealed class UpdateTransferConfigRequest : IMessage<UpdateTransferConfigRequest>, IEquatable<UpdateTransferConfigRequest>, IDeepCloneable<UpdateTransferConfigRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google BigQuery Data Transfer v1 API class UpdateTransferConfigRequest.

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

When using a cross project service account for updating 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.

Inheritance

object > UpdateTransferConfigRequest

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

UpdateTransferConfigRequest()

public UpdateTransferConfigRequest()

UpdateTransferConfigRequest(UpdateTransferConfigRequest)

public UpdateTransferConfigRequest(UpdateTransferConfigRequest other)
Parameter
Name Description
other UpdateTransferConfigRequest

Properties

AuthorizationCode

[Obsolete]
public string AuthorizationCode { get; set; }

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: <pre class="prettyprint" suppresswarning="true"> https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>; </pre>

  • The <var>client_id</var> is the OAuth client_id of the data source as returned by ListDataSources method.
  • <var>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 update the transfer config.

Property Value
Type Description
string

ServiceAccountName

public string ServiceAccountName { get; set; }

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.

Property Value
Type Description
string

TransferConfig

public TransferConfig TransferConfig { get; set; }

Required. Data transfer configuration to create.

Property Value
Type Description
TransferConfig

UpdateMask

public FieldMask UpdateMask { get; set; }

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

Property Value
Type Description
FieldMask

VersionInfo

public string VersionInfo { get; set; }

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: <pre class="prettyprint" suppresswarning="true"> https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>; </pre>

  • The <var>client_id</var> is the OAuth client_id of the data source as returned by ListDataSources method.
  • <var>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 update the transfer config.

Property Value
Type Description
string