Class UpdateTransferConfigRequest (3.4.0)

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

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

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
NameDescription
otherUpdateTransferConfigRequest

Properties

AuthorizationCode

public string AuthorizationCode { get; set; }

Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. 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

ServiceAccountName

public string ServiceAccountName { get; set; }

Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use 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

UpdateMask

public FieldMask UpdateMask { get; set; }

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

Property Value
TypeDescription
FieldMask

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