Class CreateTransferConfigRequest.Builder (2.18.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

Inheritance

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

Implements

CreateTransferConfigRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAuthorizationCode()

public CreateTransferConfigRequest.Builder clearAuthorizationCode()

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

string authorization_code = 3;

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateTransferConfigRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`CreateTransferConfigRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getAuthorizationCode()

public String getAuthorizationCode()

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

string authorization_code = 3;

Returns
Type	Description
`String`	The authorizationCode.

getAuthorizationCodeBytes()

public ByteString getAuthorizationCodeBytes()

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

string authorization_code = 3;

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getParent()

public String getParent()

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

Returns
Type	Description
`String`	The parent.

getParentBytes()

public ByteString getParentBytes()

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

Returns
Type	Description
`ByteString`	The bytes for parent.

getServiceAccountName()

public String getServiceAccountName()

string service_account_name = 6;

Returns
Type	Description
`String`	The serviceAccountName.

getServiceAccountNameBytes()

public ByteString getServiceAccountNameBytes()

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

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

string version_info = 5;

Returns
Type	Description
`String`	The versionInfo.

getVersionInfoBytes()

public ByteString getVersionInfoBytes()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public CreateTransferConfigRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`CreateTransferConfigRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAuthorizationCode(String value)

public CreateTransferConfigRequest.Builder setAuthorizationCode(String value)

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

string authorization_code = 3;

Parameter
Name	Description
`value`	`String` The authorizationCode to set.

Returns
Type	Description
`CreateTransferConfigRequest.Builder`	This builder for chaining.

setAuthorizationCodeBytes(ByteString value)

public CreateTransferConfigRequest.Builder setAuthorizationCodeBytes(ByteString value)

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

string authorization_code = 3;

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setParent(String value)

public CreateTransferConfigRequest.Builder setParent(String value)

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)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setServiceAccountName(String value)

public CreateTransferConfigRequest.Builder setServiceAccountName(String value)

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)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVersionInfo(String value)

public CreateTransferConfigRequest.Builder setVersionInfo(String value)

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

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