Class CreateTransferConfigRequest

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

A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, an authorization code must be provided. If an authorization code is provided, the transfer configuration will be associated with the user id corresponding to the authorization code. Otherwise, the transfer configuration will be associated with the calling user.

Inheritance

Object > CreateTransferConfigRequest

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

CreateTransferConfigRequest()

public CreateTransferConfigRequest()

CreateTransferConfigRequest(CreateTransferConfigRequest)

public CreateTransferConfigRequest(CreateTransferConfigRequest other)
Parameter
TypeNameDescription
CreateTransferConfigRequestother

Properties

AuthorizationCode

public string AuthorizationCode { get; set; }

Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>

  • client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
  • data_source_scopes are the scopes returned by ListDataSources method.
  • redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
Property Value
TypeDescription
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
TypeDescription
String

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
TypeDescription
LocationName

ParentAsProjectName

public ProjectName ParentAsProjectName { get; set; }

ProjectName-typed view over the Parent resource name property.

Property Value
TypeDescription
ProjectName

ParentAsResourceName

public IResourceName ParentAsResourceName { get; set; }

IResourceName-typed view over the Parent resource name property.

Property Value
TypeDescription
IResourceName

ServiceAccountName

public string ServiceAccountName { get; set; }

Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

Property Value
TypeDescription
String

TransferConfig

public TransferConfig TransferConfig { get; set; }

Required. Data transfer configuration to create.

Property Value
TypeDescription
TransferConfig

VersionInfo

public string VersionInfo { get; set; }

Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

Property Value
TypeDescription
String