com.google.cloud.bigquery.datatransfer.v1

Interface UpdateTransferConfigRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UpdateTransferConfigRequest, UpdateTransferConfigRequest.Builder

public interface UpdateTransferConfigRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAuthorizationCode() Optional OAuth2 authorization code to use with this transfer configuration.
com.google.protobuf.ByteString	getAuthorizationCodeBytes() Optional OAuth2 authorization code to use with this transfer configuration.
String	getServiceAccountName() Optional service account email.
com.google.protobuf.ByteString	getServiceAccountNameBytes() Optional service account email.
TransferConfig	getTransferConfig() Required.
TransferConfigOrBuilder	getTransferConfigOrBuilder() Required.
com.google.protobuf.FieldMask	getUpdateMask() Required.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Required.
String	getVersionInfo() Optional version info.
com.google.protobuf.ByteString	getVersionInfoBytes() Optional version info.
boolean	hasTransferConfig() Required.
boolean	hasUpdateMask() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasTransferConfig

boolean hasTransferConfig()

 Required. Data transfer configuration to create.
 

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

Returns:

Whether the transferConfig field is set.

getTransferConfig

TransferConfig getTransferConfig()

 Required. Data transfer configuration to create.
 

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

Returns:

The transferConfig.

getTransferConfigOrBuilder

TransferConfigOrBuilder getTransferConfigOrBuilder()

 Required. Data transfer configuration to create.
 

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

getAuthorizationCode

String getAuthorizationCode()

 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:

The authorizationCode.

getAuthorizationCodeBytes

com.google.protobuf.ByteString getAuthorizationCodeBytes()

 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:

The bytes for authorizationCode.

hasUpdateMask

boolean hasUpdateMask()

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

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

Returns:

Whether the updateMask field is set.

getUpdateMask

com.google.protobuf.FieldMask getUpdateMask()

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

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

Returns:

The updateMask.

getUpdateMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()

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

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

getVersionInfo

String getVersionInfo()

 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:

The versionInfo.

getVersionInfoBytes

com.google.protobuf.ByteString getVersionInfoBytes()

 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:

The bytes for versionInfo.

getServiceAccountName

String getServiceAccountName()

 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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
 

string service_account_name = 6;

Returns:

The serviceAccountName.

getServiceAccountNameBytes

com.google.protobuf.ByteString getServiceAccountNameBytes()

 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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
 

string service_account_name = 6;

Returns:

The bytes for serviceAccountName.