Class CreateTransferConfigRequest.Builder (2.48.0)

public static final class CreateTransferConfigRequest.Builder extends GeneratedMessageV3.Builder<CreateTransferConfigRequest.Builder> implements CreateTransferConfigRequestOrBuilder

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

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CreateTransferConfigRequest build()
Returns
Type Description
CreateTransferConfigRequest

buildPartial()

public CreateTransferConfigRequest buildPartial()
Returns
Type Description
CreateTransferConfigRequest

clear()

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

clearAuthorizationCode() (deprecated)

public CreateTransferConfigRequest.Builder clearAuthorizationCode()

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

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

string authorization_code = 3 [deprecated = true];

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public CreateTransferConfigRequest.Builder clearParent()

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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.

clearServiceAccountName()

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

This builder for chaining.

clearTransferConfig()

public CreateTransferConfigRequest.Builder clearTransferConfig()

Required. Data transfer configuration to create.

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

Returns
Type Description
CreateTransferConfigRequest.Builder

clearVersionInfo()

public CreateTransferConfigRequest.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 create the transfer config.

string version_info = 5;

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.

clone()

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

getAuthorizationCode() (deprecated)

public String getAuthorizationCode()

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

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 create 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.CreateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=532

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

string authorization_code = 3 [deprecated = true];

Returns
Type Description
ByteString

The bytes for authorizationCode.

getDefaultInstanceForType()

public CreateTransferConfigRequest getDefaultInstanceForType()
Returns
Type Description
CreateTransferConfigRequest

getDescriptorForType()

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

getParent()

public String getParent()

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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

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 = 2 [(.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 = 2 [(.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 = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferConfigOrBuilder

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 create 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 create 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 = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the transferConfig field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreateTransferConfigRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeTransferConfig(TransferConfig value)

public CreateTransferConfigRequest.Builder mergeTransferConfig(TransferConfig value)

Required. Data transfer configuration to create.

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

Parameter
Name Description
value TransferConfig
Returns
Type Description
CreateTransferConfigRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAuthorizationCode(String value) (deprecated)

public CreateTransferConfigRequest.Builder setAuthorizationCode(String value)

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

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

string authorization_code = 3 [deprecated = true];

Parameter
Name Description
value String

The authorizationCode to set.

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.

setAuthorizationCodeBytes(ByteString value) (deprecated)

public CreateTransferConfigRequest.Builder setAuthorizationCodeBytes(ByteString value)

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

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

string authorization_code = 3 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes for authorizationCode to set.

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public CreateTransferConfigRequest.Builder setParent(String value)

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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateTransferConfigRequest.Builder setParentBytes(ByteString value)

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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.

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

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

setServiceAccountName(String value)

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

This builder for chaining.

setServiceAccountNameBytes(ByteString value)

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

This builder for chaining.

setTransferConfig(TransferConfig value)

public CreateTransferConfigRequest.Builder setTransferConfig(TransferConfig value)

Required. Data transfer configuration to create.

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

Parameter
Name Description
value TransferConfig
Returns
Type Description
CreateTransferConfigRequest.Builder

setTransferConfig(TransferConfig.Builder builderForValue)

public CreateTransferConfigRequest.Builder setTransferConfig(TransferConfig.Builder builderForValue)

Required. Data transfer configuration to create.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setVersionInfo(String value)

public CreateTransferConfigRequest.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 create the transfer config.

string version_info = 5;

Parameter
Name Description
value String

The versionInfo to set.

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.

setVersionInfoBytes(ByteString value)

public CreateTransferConfigRequest.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 create the transfer config.

string version_info = 5;

Parameter
Name Description
value ByteString

The bytes for versionInfo to set.

Returns
Type Description
CreateTransferConfigRequest.Builder

This builder for chaining.