Class CreateTransferConfigRequest.Builder (2.3.11)

Stay organized with collections Save and categorize content based on your preferences.
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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateTransferConfigRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides

build()

public CreateTransferConfigRequest build()
Returns
TypeDescription
CreateTransferConfigRequest

buildPartial()

public CreateTransferConfigRequest buildPartial()
Returns
TypeDescription
CreateTransferConfigRequest

clear()

public CreateTransferConfigRequest.Builder clear()
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides

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;

Returns
TypeDescription
CreateTransferConfigRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateTransferConfigRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateTransferConfigRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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;

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

Returns
TypeDescription
CreateTransferConfigRequest.Builder

This builder for chaining.

clone()

public CreateTransferConfigRequest.Builder clone()
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides

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;

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

Returns
TypeDescription
ByteString

The bytes for authorizationCode.

getDefaultInstanceForType()

public CreateTransferConfigRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateTransferConfigRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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;

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

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

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the transferConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CreateTransferConfigRequest other)

public CreateTransferConfigRequest.Builder mergeFrom(CreateTransferConfigRequest other)
Parameter
NameDescription
otherCreateTransferConfigRequest
Returns
TypeDescription
CreateTransferConfigRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateTransferConfigRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CreateTransferConfigRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueTransferConfig
Returns
TypeDescription
CreateTransferConfigRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateTransferConfigRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides

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;

Parameter
NameDescription
valueString

The authorizationCode to set.

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

Parameter
NameDescription
valueByteString

The bytes for authorizationCode to set.

Returns
TypeDescription
CreateTransferConfigRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateTransferConfigRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides

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;

Parameter
NameDescription
valueString

The serviceAccountName to set.

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

Parameter
NameDescription
valueByteString

The bytes for serviceAccountName to set.

Returns
TypeDescription
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
NameDescription
valueTransferConfig
Returns
TypeDescription
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
NameDescription
builderForValueTransferConfig.Builder
Returns
TypeDescription
CreateTransferConfigRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateTransferConfigRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides

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;

Parameter
NameDescription
valueString

The versionInfo to set.

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

Parameter
NameDescription
valueByteString

The bytes for versionInfo to set.

Returns
TypeDescription
CreateTransferConfigRequest.Builder

This builder for chaining.