Class UpdateTransferConfigRequest.Builder (2.53.0) 

public static final class UpdateTransferConfigRequest.Builder extends GeneratedMessageV3.Builder<UpdateTransferConfigRequest.Builder> implements UpdateTransferConfigRequestOrBuilder

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

When using a cross project service account for updating a transfer config, you must enable cross project service account usage. For more information, see Disable attachment of service accounts to resources in other projects.

Protobuf type google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateTransferConfigRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateTransferConfigRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

build()

public UpdateTransferConfigRequest build()
Returns
Type Description
UpdateTransferConfigRequest

buildPartial()

public UpdateTransferConfigRequest buildPartial()
Returns
Type Description
UpdateTransferConfigRequest

clear()

public UpdateTransferConfigRequest.Builder clear()
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

clearAuthorizationCode() (deprecated)

public UpdateTransferConfigRequest.Builder clearAuthorizationCode()

Deprecated. google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=597

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

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://bigquery.cloud.google.com/datatransfer/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 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 [deprecated = true];

Returns
Type Description
UpdateTransferConfigRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UpdateTransferConfigRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateTransferConfigRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

clearServiceAccountName()

public UpdateTransferConfigRequest.Builder clearServiceAccountName()

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
UpdateTransferConfigRequest.Builder

This builder for chaining.

clearTransferConfig()

public UpdateTransferConfigRequest.Builder clearTransferConfig()

Required. Data transfer configuration to create.

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

Returns
Type Description
UpdateTransferConfigRequest.Builder

clearUpdateMask()

public UpdateTransferConfigRequest.Builder clearUpdateMask()

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
UpdateTransferConfigRequest.Builder

clearVersionInfo()

public UpdateTransferConfigRequest.Builder clearVersionInfo()

Optional version info. This parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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://bigquery.cloud.google.com/datatransfer/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 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
UpdateTransferConfigRequest.Builder

This builder for chaining.

clone()

public UpdateTransferConfigRequest.Builder clone()
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

getAuthorizationCode() (deprecated)

public String getAuthorizationCode()

Deprecated. google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=597

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

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://bigquery.cloud.google.com/datatransfer/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 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 [deprecated = true];

Returns
Type Description
String

The authorizationCode.

getAuthorizationCodeBytes() (deprecated)

public ByteString getAuthorizationCodeBytes()

Deprecated. google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=597

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

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://bigquery.cloud.google.com/datatransfer/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 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 [deprecated = true];

Returns
Type Description
ByteString

The bytes for authorizationCode.

getDefaultInstanceForType()

public UpdateTransferConfigRequest getDefaultInstanceForType()
Returns
Type Description
UpdateTransferConfigRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getServiceAccountName()

public 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.

string service_account_name = 6;

Returns
Type Description
String

The serviceAccountName.

getServiceAccountNameBytes()

public 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.

string service_account_name = 6;

Returns
Type Description
ByteString

The bytes for serviceAccountName.

getTransferConfig()

public TransferConfig getTransferConfig()

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.

getTransferConfigBuilder()

public TransferConfig.Builder getTransferConfigBuilder()

Required. Data transfer configuration to create.

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

Returns
Type Description
TransferConfig.Builder

getTransferConfigOrBuilder()

public TransferConfigOrBuilder getTransferConfigOrBuilder()

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()

public 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
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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()

public String getVersionInfo()

Optional version info. This parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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://bigquery.cloud.google.com/datatransfer/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 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()

public ByteString getVersionInfoBytes()

Optional version info. This parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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://bigquery.cloud.google.com/datatransfer/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 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()

public boolean hasTransferConfig()

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()

public 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
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateTransferConfigRequest other)

public UpdateTransferConfigRequest.Builder mergeFrom(UpdateTransferConfigRequest other)
Parameter
Name Description
other UpdateTransferConfigRequest
Returns
Type Description
UpdateTransferConfigRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateTransferConfigRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateTransferConfigRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

mergeTransferConfig(TransferConfig value)

public UpdateTransferConfigRequest.Builder mergeTransferConfig(TransferConfig value)

Required. Data transfer configuration to create.

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

Parameter
Name Description
value TransferConfig
Returns
Type Description
UpdateTransferConfigRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateTransferConfigRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateTransferConfigRequest.Builder mergeUpdateMask(FieldMask value)

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

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

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateTransferConfigRequest.Builder

setAuthorizationCode(String value) (deprecated)

public UpdateTransferConfigRequest.Builder setAuthorizationCode(String value)

Deprecated. google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=597

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

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://bigquery.cloud.google.com/datatransfer/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 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 [deprecated = true];

Parameter
Name Description
value String

The authorizationCode to set.
Returns
Type Description
UpdateTransferConfigRequest.Builder

This builder for chaining.

setAuthorizationCodeBytes(ByteString value) (deprecated)

public UpdateTransferConfigRequest.Builder setAuthorizationCodeBytes(ByteString value)

Deprecated. google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=597

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

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://bigquery.cloud.google.com/datatransfer/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 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 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes for authorizationCode to set.
Returns
Type Description
UpdateTransferConfigRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateTransferConfigRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateTransferConfigRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

setServiceAccountName(String value)

public UpdateTransferConfigRequest.Builder setServiceAccountName(String value)

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;

Parameter
Name Description
value String

The serviceAccountName to set.
Returns
Type Description
UpdateTransferConfigRequest.Builder

This builder for chaining.

setServiceAccountNameBytes(ByteString value)

public UpdateTransferConfigRequest.Builder setServiceAccountNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for serviceAccountName to set.
Returns
Type Description
UpdateTransferConfigRequest.Builder

This builder for chaining.

setTransferConfig(TransferConfig value)

public UpdateTransferConfigRequest.Builder setTransferConfig(TransferConfig value)

Required. Data transfer configuration to create.

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

Parameter
Name Description
value TransferConfig
Returns
Type Description
UpdateTransferConfigRequest.Builder

setTransferConfig(TransferConfig.Builder builderForValue)

public UpdateTransferConfigRequest.Builder setTransferConfig(TransferConfig.Builder builderForValue)

Required. Data transfer configuration to create.

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

Parameter
Name Description
builderForValue TransferConfig.Builder
Returns
Type Description
UpdateTransferConfigRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateTransferConfigRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateTransferConfigRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateTransferConfigRequest.Builder setUpdateMask(FieldMask value)

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

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

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateTransferConfigRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateTransferConfigRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateTransferConfigRequest.Builder

setVersionInfo(String value)

public UpdateTransferConfigRequest.Builder setVersionInfo(String value)

Optional version info. This parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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://bigquery.cloud.google.com/datatransfer/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 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;

Parameter
Name Description
value String

The versionInfo to set.
Returns
Type Description
UpdateTransferConfigRequest.Builder

This builder for chaining.

setVersionInfoBytes(ByteString value)

public UpdateTransferConfigRequest.Builder setVersionInfoBytes(ByteString value)

Optional version info. This parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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://bigquery.cloud.google.com/datatransfer/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 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;

Parameter
Name Description
value ByteString

The bytes for versionInfo to set.
Returns
Type Description
UpdateTransferConfigRequest.Builder

This builder for chaining.