Google BigQuery Data Transfer v1 API - Class CreateTransferConfigRequest (4.8.0)

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

Reference documentation and code samples for the Google BigQuery Data Transfer v1 API 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.

Inheritance

object > CreateTransferConfigRequest

Implements

IMessage CreateTransferConfigRequest, IEquatable CreateTransferConfigRequest, IDeepCloneable CreateTransferConfigRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

CreateTransferConfigRequest()

public CreateTransferConfigRequest()

CreateTransferConfigRequest(CreateTransferConfigRequest)

public CreateTransferConfigRequest(CreateTransferConfigRequest other)

Parameter
Name	Description
`other`	`CreateTransferConfigRequest`

Properties

AuthorizationCode

public string AuthorizationCode { get; set; }

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://www.gstatic.com/bigquerydatatransfer/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 a 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 create the transfer config.

Property Value
Type	Description
`string`

Parent

public string Parent { get; set; }

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.

Property Value
Type	Description
`string`

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type	Description
`LocationName`

ParentAsProjectName

public ProjectName ParentAsProjectName { get; set; }

ProjectName-typed view over the Parent resource name property.

Property Value
Type	Description
`ProjectName`

ParentAsResourceName

public IResourceName ParentAsResourceName { get; set; }

IResourceName-typed view over the Parent resource name property.

Property Value
Type	Description
`IResourceName`

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`

VersionInfo

public string VersionInfo { get; set; }

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: <pre class="prettyprint" suppresswarning="true"> https://www.gstatic.com/bigquerydatatransfer/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 a 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 create the transfer config.

Property Value
Type	Description
`string`