- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.17
- 2.2.6
- 2.1.23
- 2.0.27
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, an authorization code must be provided. If an authorization code is provided, the transfer configuration will be associated with the user id corresponding to the authorization code. 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.BuilderImplements
CreateTransferConfigRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreateTransferConfigRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
CreateTransferConfigRequest.Builder |
build()
public CreateTransferConfigRequest build()
Type | Description |
CreateTransferConfigRequest |
buildPartial()
public CreateTransferConfigRequest buildPartial()
Type | Description |
CreateTransferConfigRequest |
clear()
public CreateTransferConfigRequest.Builder clear()
Type | Description |
CreateTransferConfigRequest.Builder |
clearAuthorizationCode()
public CreateTransferConfigRequest.Builder clearAuthorizationCode()
Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
CheckValidCreds
.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
string authorization_code = 3;
Type | Description |
CreateTransferConfigRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CreateTransferConfigRequest.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
CreateTransferConfigRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateTransferConfigRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
CreateTransferConfigRequest.Builder |
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) = { ... }
Type | Description |
CreateTransferConfigRequest.Builder | This builder for chaining. |
clearServiceAccountName()
public CreateTransferConfigRequest.Builder clearServiceAccountName()
Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
string service_account_name = 6;
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];
Type | Description |
CreateTransferConfigRequest.Builder |
clearVersionInfo()
public CreateTransferConfigRequest.Builder clearVersionInfo()
Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
string version_info = 5;
Type | Description |
CreateTransferConfigRequest.Builder | This builder for chaining. |
clone()
public CreateTransferConfigRequest.Builder clone()
Type | Description |
CreateTransferConfigRequest.Builder |
getAuthorizationCode()
public String getAuthorizationCode()
Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
CheckValidCreds
.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
string authorization_code = 3;
Type | Description |
String | The authorizationCode. |
getAuthorizationCodeBytes()
public ByteString getAuthorizationCodeBytes()
Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
CheckValidCreds
.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
string authorization_code = 3;
Type | Description |
ByteString | The bytes for authorizationCode. |
getDefaultInstanceForType()
public CreateTransferConfigRequest getDefaultInstanceForType()
Type | Description |
CreateTransferConfigRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
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) = { ... }
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) = { ... }
Type | Description |
ByteString | The bytes for parent. |
getServiceAccountName()
public String getServiceAccountName()
Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
string service_account_name = 6;
Type | Description |
String | The serviceAccountName. |
getServiceAccountNameBytes()
public ByteString getServiceAccountNameBytes()
Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
string service_account_name = 6;
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];
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];
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];
Type | Description |
TransferConfigOrBuilder |
getVersionInfo()
public String getVersionInfo()
Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
string version_info = 5;
Type | Description |
String | The versionInfo. |
getVersionInfoBytes()
public ByteString getVersionInfoBytes()
Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
string version_info = 5;
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];
Type | Description |
boolean | Whether the transferConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(CreateTransferConfigRequest other)
public CreateTransferConfigRequest.Builder mergeFrom(CreateTransferConfigRequest other)
Name | Description |
other | CreateTransferConfigRequest |
Type | Description |
CreateTransferConfigRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateTransferConfigRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
CreateTransferConfigRequest.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public CreateTransferConfigRequest.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
CreateTransferConfigRequest.Builder |
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];
Name | Description |
value | TransferConfig |
Type | Description |
CreateTransferConfigRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateTransferConfigRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
CreateTransferConfigRequest.Builder |
setAuthorizationCode(String value)
public CreateTransferConfigRequest.Builder setAuthorizationCode(String value)
Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
CheckValidCreds
.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
string authorization_code = 3;
Name | Description |
value | String The authorizationCode to set. |
Type | Description |
CreateTransferConfigRequest.Builder | This builder for chaining. |
setAuthorizationCodeBytes(ByteString value)
public CreateTransferConfigRequest.Builder setAuthorizationCodeBytes(ByteString value)
Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
CheckValidCreds
.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
string authorization_code = 3;
Name | Description |
value | ByteString The bytes for authorizationCode to set. |
Type | Description |
CreateTransferConfigRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CreateTransferConfigRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
CreateTransferConfigRequest.Builder |
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) = { ... }
Name | Description |
value | String The parent to set. |
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) = { ... }
Name | Description |
value | ByteString The bytes for parent to set. |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
CreateTransferConfigRequest.Builder |
setServiceAccountName(String value)
public CreateTransferConfigRequest.Builder setServiceAccountName(String value)
Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
string service_account_name = 6;
Name | Description |
value | String The serviceAccountName to set. |
Type | Description |
CreateTransferConfigRequest.Builder | This builder for chaining. |
setServiceAccountNameBytes(ByteString value)
public CreateTransferConfigRequest.Builder setServiceAccountNameBytes(ByteString value)
Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
string service_account_name = 6;
Name | Description |
value | ByteString The bytes for serviceAccountName to set. |
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];
Name | Description |
value | TransferConfig |
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];
Name | Description |
builderForValue | TransferConfig.Builder |
Type | Description |
CreateTransferConfigRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateTransferConfigRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
CreateTransferConfigRequest.Builder |
setVersionInfo(String value)
public CreateTransferConfigRequest.Builder setVersionInfo(String value)
Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
string version_info = 5;
Name | Description |
value | String The versionInfo to set. |
Type | Description |
CreateTransferConfigRequest.Builder | This builder for chaining. |
setVersionInfoBytes(ByteString value)
public CreateTransferConfigRequest.Builder setVersionInfoBytes(ByteString value)
Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
string version_info = 5;
Name | Description |
value | ByteString The bytes for versionInfo to set. |
Type | Description |
CreateTransferConfigRequest.Builder | This builder for chaining. |