Interface UpdateTransferConfigRequestOrBuilder (2.13.0)

publicinterface UpdateTransferConfigRequestOrBuilderextendsMessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthorizationCode()

publicabstractStringgetAuthorizationCode()

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

string authorization_code = 3;

Returns
Type Description
String

The authorizationCode.

getAuthorizationCodeBytes()

publicabstractByteStringgetAuthorizationCodeBytes()

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

string authorization_code = 3;

Returns
Type Description
ByteString

The bytes for authorizationCode.

getServiceAccountName()

publicabstractStringgetServiceAccountName()

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.

string service_account_name = 6;

Returns
Type Description
String

The serviceAccountName.

getServiceAccountNameBytes()

publicabstractByteStringgetServiceAccountNameBytes()

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.

string service_account_name = 6;

Returns
Type Description
ByteString

The bytes for serviceAccountName.

getTransferConfig()

publicabstractTransferConfiggetTransferConfig()

Required. Data transfer configuration to create.

.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferConfig

The transferConfig.

getTransferConfigOrBuilder()

publicabstractTransferConfigOrBuildergetTransferConfigOrBuilder()

Required. Data transfer configuration to create.

.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferConfigOrBuilder

getUpdateMask()

publicabstractFieldMaskgetUpdateMask()

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

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

publicabstractFieldMaskOrBuildergetUpdateMaskOrBuilder()

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

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMaskOrBuilder

getVersionInfo()

publicabstractStringgetVersionInfo()

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

string version_info = 5;

Returns
Type Description
String

The versionInfo.

getVersionInfoBytes()

publicabstractByteStringgetVersionInfoBytes()

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

string version_info = 5;

Returns
Type Description
ByteString

The bytes for versionInfo.

hasTransferConfig()

publicabstractbooleanhasTransferConfig()

Required. Data transfer configuration to create.

.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the transferConfig field is set.

hasUpdateMask()

publicabstractbooleanhasUpdateMask()

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

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the updateMask field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.