Class CreateTransferConfigRequest.Builder (2.45.0)

publicstaticfinalclass CreateTransferConfigRequest.BuilderextendsGeneratedMessageV3.Builder<CreateTransferConfigRequest.Builder>implementsCreateTransferConfigRequestOrBuilder

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

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicCreateTransferConfigRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)

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

publicCreateTransferConfigRequestbuild()

publicCreateTransferConfigRequestbuildPartial()

publicCreateTransferConfigRequest.Builderclear()

GeneratedMessageV3.Builder<BuilderType>.clear()

publicCreateTransferConfigRequest.BuilderclearAuthorizationCode()

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

publicCreateTransferConfigRequest.BuilderclearField(Descriptors.FieldDescriptorfield)

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

publicCreateTransferConfigRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)

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

publicCreateTransferConfigRequest.BuilderclearParent()

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) = { ... }

publicCreateTransferConfigRequest.BuilderclearServiceAccountName()

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;

publicCreateTransferConfigRequest.BuilderclearTransferConfig()

Required. Data transfer configuration to create.

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

publicCreateTransferConfigRequest.BuilderclearVersionInfo()

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://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 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;

publicCreateTransferConfigRequest.Builderclone()

GeneratedMessageV3.Builder<BuilderType>.clone()

publicStringgetAuthorizationCode()

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

publicByteStringgetAuthorizationCodeBytes()

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

publicCreateTransferConfigRequestgetDefaultInstanceForType()

publicDescriptors.DescriptorgetDescriptorForType()

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

publicStringgetParent()

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) = { ... }

publicByteStringgetParentBytes()

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) = { ... }

publicStringgetServiceAccountName()

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;

publicByteStringgetServiceAccountNameBytes()

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;

publicTransferConfiggetTransferConfig()

Required. Data transfer configuration to create.

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

publicTransferConfig.BuildergetTransferConfigBuilder()

Required. Data transfer configuration to create.

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

publicTransferConfigOrBuildergetTransferConfigOrBuilder()

Required. Data transfer configuration to create.

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

publicStringgetVersionInfo()

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://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 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;

publicByteStringgetVersionInfoBytes()

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://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 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;

publicbooleanhasTransferConfig()

Required. Data transfer configuration to create.

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

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

publicCreateTransferConfigRequest.BuildermergeFrom(CreateTransferConfigRequestother)

publicCreateTransferConfigRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

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

publicCreateTransferConfigRequest.BuildermergeFrom(Messageother)

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

publicCreateTransferConfigRequest.BuildermergeTransferConfig(TransferConfigvalue)

Required. Data transfer configuration to create.

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

publicfinalCreateTransferConfigRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)

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

publicCreateTransferConfigRequest.BuildersetAuthorizationCode(Stringvalue)

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

publicCreateTransferConfigRequest.BuildersetAuthorizationCodeBytes(ByteStringvalue)

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

publicCreateTransferConfigRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)

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

publicCreateTransferConfigRequest.BuildersetParent(Stringvalue)

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) = { ... }

publicCreateTransferConfigRequest.BuildersetParentBytes(ByteStringvalue)

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) = { ... }

publicCreateTransferConfigRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)

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

publicCreateTransferConfigRequest.BuildersetServiceAccountName(Stringvalue)

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;

publicCreateTransferConfigRequest.BuildersetServiceAccountNameBytes(ByteStringvalue)

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;

publicCreateTransferConfigRequest.BuildersetTransferConfig(TransferConfigvalue)

Required. Data transfer configuration to create.

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

publicCreateTransferConfigRequest.BuildersetTransferConfig(TransferConfig.BuilderbuilderForValue)

Required. Data transfer configuration to create.

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

publicfinalCreateTransferConfigRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)

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

publicCreateTransferConfigRequest.BuildersetVersionInfo(Stringvalue)

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://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 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;

publicCreateTransferConfigRequest.BuildersetVersionInfoBytes(ByteStringvalue)

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://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 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;