Class TransferConfig.Builder (2.43.0)

public static final class TransferConfig.Builder extends GeneratedMessageV3.Builder<TransferConfig.Builder> implements TransferConfigOrBuilder

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destination_dataset_id specifies where data should be stored. When a new transfer configuration is created, the specified destination_dataset_id is created when needed and shared with the appropriate data source service account.

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

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public TransferConfig build()
Returns
Type Description
TransferConfig

buildPartial()

public TransferConfig buildPartial()
Returns
Type Description
TransferConfig

clear()

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

clearDataRefreshWindowDays()

public TransferConfig.Builder clearDataRefreshWindowDays()

The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.

int32 data_refresh_window_days = 12;

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearDataSourceId()

public TransferConfig.Builder clearDataSourceId()

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

string data_source_id = 5;

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearDatasetRegion()

public TransferConfig.Builder clearDatasetRegion()

Output only. Region in which BigQuery dataset is located.

string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearDestination()

public TransferConfig.Builder clearDestination()
Returns
Type Description
TransferConfig.Builder

clearDestinationDatasetId()

public TransferConfig.Builder clearDestinationDatasetId()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearDisabled()

public TransferConfig.Builder clearDisabled()

Is this config disabled. When set to true, no runs will be scheduled for this transfer config.

bool disabled = 13;

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearDisplayName()

public TransferConfig.Builder clearDisplayName()

User specified display name for the data transfer.

string display_name = 3;

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearEmailPreferences()

public TransferConfig.Builder clearEmailPreferences()

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Returns
Type Description
TransferConfig.Builder

clearEncryptionConfiguration()

public TransferConfig.Builder clearEncryptionConfiguration()

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Returns
Type Description
TransferConfig.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public TransferConfig.Builder clearName()

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearNextRunTime()

public TransferConfig.Builder clearNextRunTime()

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TransferConfig.Builder

clearNotificationPubsubTopic()

public TransferConfig.Builder clearNotificationPubsubTopic()

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

string notification_pubsub_topic = 15;

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOwnerInfo()

public TransferConfig.Builder clearOwnerInfo()

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TransferConfig.Builder

clearParams()

public TransferConfig.Builder clearParams()

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Returns
Type Description
TransferConfig.Builder

clearSchedule()

public TransferConfig.Builder clearSchedule()

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 7;

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearScheduleOptions()

public TransferConfig.Builder clearScheduleOptions()

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Returns
Type Description
TransferConfig.Builder

clearState()

public TransferConfig.Builder clearState()

Output only. State of the most recently updated transfer run.

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clearUpdateTime()

public TransferConfig.Builder clearUpdateTime()

Output only. Data transfer modification time. Ignored by server on input.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TransferConfig.Builder

clearUserId()

public TransferConfig.Builder clearUserId()

Deprecated. Unique ID of the user on whose behalf transfer is done.

int64 user_id = 11;

Returns
Type Description
TransferConfig.Builder

This builder for chaining.

clone()

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

getDataRefreshWindowDays()

public int getDataRefreshWindowDays()

The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.

int32 data_refresh_window_days = 12;

Returns
Type Description
int

The dataRefreshWindowDays.

getDataSourceId()

public String getDataSourceId()

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

string data_source_id = 5;

Returns
Type Description
String

The dataSourceId.

getDataSourceIdBytes()

public ByteString getDataSourceIdBytes()

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

string data_source_id = 5;

Returns
Type Description
ByteString

The bytes for dataSourceId.

getDatasetRegion()

public String getDatasetRegion()

Output only. Region in which BigQuery dataset is located.

string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The datasetRegion.

getDatasetRegionBytes()

public ByteString getDatasetRegionBytes()

Output only. Region in which BigQuery dataset is located.

string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for datasetRegion.

getDefaultInstanceForType()

public TransferConfig getDefaultInstanceForType()
Returns
Type Description
TransferConfig

getDescriptorForType()

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

getDestinationCase()

public TransferConfig.DestinationCase getDestinationCase()
Returns
Type Description
TransferConfig.DestinationCase

getDestinationDatasetId()

public String getDestinationDatasetId()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
Type Description
String

The destinationDatasetId.

getDestinationDatasetIdBytes()

public ByteString getDestinationDatasetIdBytes()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
Type Description
ByteString

The bytes for destinationDatasetId.

getDisabled()

public boolean getDisabled()

Is this config disabled. When set to true, no runs will be scheduled for this transfer config.

bool disabled = 13;

Returns
Type Description
boolean

The disabled.

getDisplayName()

public String getDisplayName()

User specified display name for the data transfer.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User specified display name for the data transfer.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getEmailPreferences()

public EmailPreferences getEmailPreferences()

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Returns
Type Description
EmailPreferences

The emailPreferences.

getEmailPreferencesBuilder()

public EmailPreferences.Builder getEmailPreferencesBuilder()

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Returns
Type Description
EmailPreferences.Builder

getEmailPreferencesOrBuilder()

public EmailPreferencesOrBuilder getEmailPreferencesOrBuilder()

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Returns
Type Description
EmailPreferencesOrBuilder

getEncryptionConfiguration()

public EncryptionConfiguration getEncryptionConfiguration()

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Returns
Type Description
EncryptionConfiguration

The encryptionConfiguration.

getEncryptionConfigurationBuilder()

public EncryptionConfiguration.Builder getEncryptionConfigurationBuilder()

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Returns
Type Description
EncryptionConfiguration.Builder

getEncryptionConfigurationOrBuilder()

public EncryptionConfigurationOrBuilder getEncryptionConfigurationOrBuilder()

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Returns
Type Description
EncryptionConfigurationOrBuilder

getName()

public String getName()

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNextRunTime()

public Timestamp getNextRunTime()

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The nextRunTime.

getNextRunTimeBuilder()

public Timestamp.Builder getNextRunTimeBuilder()

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getNextRunTimeOrBuilder()

public TimestampOrBuilder getNextRunTimeOrBuilder()

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getNotificationPubsubTopic()

public String getNotificationPubsubTopic()

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

string notification_pubsub_topic = 15;

Returns
Type Description
String

The notificationPubsubTopic.

getNotificationPubsubTopicBytes()

public ByteString getNotificationPubsubTopicBytes()

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

string notification_pubsub_topic = 15;

Returns
Type Description
ByteString

The bytes for notificationPubsubTopic.

getOwnerInfo()

public UserInfo getOwnerInfo()

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserInfo

The ownerInfo.

getOwnerInfoBuilder()

public UserInfo.Builder getOwnerInfoBuilder()

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserInfo.Builder

getOwnerInfoOrBuilder()

public UserInfoOrBuilder getOwnerInfoOrBuilder()

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserInfoOrBuilder

getParams()

public Struct getParams()

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Returns
Type Description
Struct

The params.

getParamsBuilder()

public Struct.Builder getParamsBuilder()

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Returns
Type Description
Builder

getParamsOrBuilder()

public StructOrBuilder getParamsOrBuilder()

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Returns
Type Description
StructOrBuilder

getSchedule()

public String getSchedule()

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 7;

Returns
Type Description
String

The schedule.

getScheduleBytes()

public ByteString getScheduleBytes()

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 7;

Returns
Type Description
ByteString

The bytes for schedule.

getScheduleOptions()

public ScheduleOptions getScheduleOptions()

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Returns
Type Description
ScheduleOptions

The scheduleOptions.

getScheduleOptionsBuilder()

public ScheduleOptions.Builder getScheduleOptionsBuilder()

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Returns
Type Description
ScheduleOptions.Builder

getScheduleOptionsOrBuilder()

public ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder()

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Returns
Type Description
ScheduleOptionsOrBuilder

getState()

public TransferState getState()

Output only. State of the most recently updated transfer run.

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TransferState

The state.

getStateValue()

public int getStateValue()

Output only. State of the most recently updated transfer run.

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Data transfer modification time. Ignored by server on input.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Data transfer modification time. Ignored by server on input.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Data transfer modification time. Ignored by server on input.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getUserId()

public long getUserId()

Deprecated. Unique ID of the user on whose behalf transfer is done.

int64 user_id = 11;

Returns
Type Description
long

The userId.

hasDestinationDatasetId()

public boolean hasDestinationDatasetId()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
Type Description
boolean

Whether the destinationDatasetId field is set.

hasEmailPreferences()

public boolean hasEmailPreferences()

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Returns
Type Description
boolean

Whether the emailPreferences field is set.

hasEncryptionConfiguration()

public boolean hasEncryptionConfiguration()

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Returns
Type Description
boolean

Whether the encryptionConfiguration field is set.

hasNextRunTime()

public boolean hasNextRunTime()

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the nextRunTime field is set.

hasOwnerInfo()

public boolean hasOwnerInfo()

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the ownerInfo field is set.

hasParams()

public boolean hasParams()

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Returns
Type Description
boolean

Whether the params field is set.

hasScheduleOptions()

public boolean hasScheduleOptions()

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Returns
Type Description
boolean

Whether the scheduleOptions field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Data transfer modification time. Ignored by server on input.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEmailPreferences(EmailPreferences value)

public TransferConfig.Builder mergeEmailPreferences(EmailPreferences value)

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Parameter
Name Description
value EmailPreferences
Returns
Type Description
TransferConfig.Builder

mergeEncryptionConfiguration(EncryptionConfiguration value)

public TransferConfig.Builder mergeEncryptionConfiguration(EncryptionConfiguration value)

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Parameter
Name Description
value EncryptionConfiguration
Returns
Type Description
TransferConfig.Builder

mergeFrom(TransferConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeNextRunTime(Timestamp value)

public TransferConfig.Builder mergeNextRunTime(Timestamp value)

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferConfig.Builder

mergeOwnerInfo(UserInfo value)

public TransferConfig.Builder mergeOwnerInfo(UserInfo value)

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value UserInfo
Returns
Type Description
TransferConfig.Builder

mergeParams(Struct value)

public TransferConfig.Builder mergeParams(Struct value)

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Parameter
Name Description
value Struct
Returns
Type Description
TransferConfig.Builder

mergeScheduleOptions(ScheduleOptions value)

public TransferConfig.Builder mergeScheduleOptions(ScheduleOptions value)

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Parameter
Name Description
value ScheduleOptions
Returns
Type Description
TransferConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public TransferConfig.Builder mergeUpdateTime(Timestamp value)

Output only. Data transfer modification time. Ignored by server on input.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferConfig.Builder

setDataRefreshWindowDays(int value)

public TransferConfig.Builder setDataRefreshWindowDays(int value)

The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.

int32 data_refresh_window_days = 12;

Parameter
Name Description
value int

The dataRefreshWindowDays to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDataSourceId(String value)

public TransferConfig.Builder setDataSourceId(String value)

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

string data_source_id = 5;

Parameter
Name Description
value String

The dataSourceId to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDataSourceIdBytes(ByteString value)

public TransferConfig.Builder setDataSourceIdBytes(ByteString value)

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

string data_source_id = 5;

Parameter
Name Description
value ByteString

The bytes for dataSourceId to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDatasetRegion(String value)

public TransferConfig.Builder setDatasetRegion(String value)

Output only. Region in which BigQuery dataset is located.

string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The datasetRegion to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDatasetRegionBytes(ByteString value)

public TransferConfig.Builder setDatasetRegionBytes(ByteString value)

Output only. Region in which BigQuery dataset is located.

string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for datasetRegion to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDestinationDatasetId(String value)

public TransferConfig.Builder setDestinationDatasetId(String value)

The BigQuery target dataset id.

string destination_dataset_id = 2;

Parameter
Name Description
value String

The destinationDatasetId to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDestinationDatasetIdBytes(ByteString value)

public TransferConfig.Builder setDestinationDatasetIdBytes(ByteString value)

The BigQuery target dataset id.

string destination_dataset_id = 2;

Parameter
Name Description
value ByteString

The bytes for destinationDatasetId to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDisabled(boolean value)

public TransferConfig.Builder setDisabled(boolean value)

Is this config disabled. When set to true, no runs will be scheduled for this transfer config.

bool disabled = 13;

Parameter
Name Description
value boolean

The disabled to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDisplayName(String value)

public TransferConfig.Builder setDisplayName(String value)

User specified display name for the data transfer.

string display_name = 3;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public TransferConfig.Builder setDisplayNameBytes(ByteString value)

User specified display name for the data transfer.

string display_name = 3;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setEmailPreferences(EmailPreferences value)

public TransferConfig.Builder setEmailPreferences(EmailPreferences value)

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

Parameter
Name Description
value EmailPreferences
Returns
Type Description
TransferConfig.Builder

setEmailPreferences(EmailPreferences.Builder builderForValue)

public TransferConfig.Builder setEmailPreferences(EmailPreferences.Builder builderForValue)

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;

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

setEncryptionConfiguration(EncryptionConfiguration value)

public TransferConfig.Builder setEncryptionConfiguration(EncryptionConfiguration value)

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

Parameter
Name Description
value EncryptionConfiguration
Returns
Type Description
TransferConfig.Builder

setEncryptionConfiguration(EncryptionConfiguration.Builder builderForValue)

public TransferConfig.Builder setEncryptionConfiguration(EncryptionConfiguration.Builder builderForValue)

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration encryption_configuration = 28;

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public TransferConfig.Builder setName(String value)

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TransferConfig.Builder setNameBytes(ByteString value)

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setNextRunTime(Timestamp value)

public TransferConfig.Builder setNextRunTime(Timestamp value)

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferConfig.Builder

setNextRunTime(Timestamp.Builder builderForValue)

public TransferConfig.Builder setNextRunTime(Timestamp.Builder builderForValue)

Output only. Next time when data transfer will run.

.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TransferConfig.Builder

setNotificationPubsubTopic(String value)

public TransferConfig.Builder setNotificationPubsubTopic(String value)

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

string notification_pubsub_topic = 15;

Parameter
Name Description
value String

The notificationPubsubTopic to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setNotificationPubsubTopicBytes(ByteString value)

public TransferConfig.Builder setNotificationPubsubTopicBytes(ByteString value)

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

string notification_pubsub_topic = 15;

Parameter
Name Description
value ByteString

The bytes for notificationPubsubTopic to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setOwnerInfo(UserInfo value)

public TransferConfig.Builder setOwnerInfo(UserInfo value)

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value UserInfo
Returns
Type Description
TransferConfig.Builder

setOwnerInfo(UserInfo.Builder builderForValue)

public TransferConfig.Builder setOwnerInfo(UserInfo.Builder builderForValue)

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

setParams(Struct value)

public TransferConfig.Builder setParams(Struct value)

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Parameter
Name Description
value Struct
Returns
Type Description
TransferConfig.Builder

setParams(Struct.Builder builderForValue)

public TransferConfig.Builder setParams(Struct.Builder builderForValue)

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

.google.protobuf.Struct params = 9;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TransferConfig.Builder

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

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

setSchedule(String value)

public TransferConfig.Builder setSchedule(String value)

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 7;

Parameter
Name Description
value String

The schedule to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setScheduleBytes(ByteString value)

public TransferConfig.Builder setScheduleBytes(ByteString value)

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 7;

Parameter
Name Description
value ByteString

The bytes for schedule to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setScheduleOptions(ScheduleOptions value)

public TransferConfig.Builder setScheduleOptions(ScheduleOptions value)

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

Parameter
Name Description
value ScheduleOptions
Returns
Type Description
TransferConfig.Builder

setScheduleOptions(ScheduleOptions.Builder builderForValue)

public TransferConfig.Builder setScheduleOptions(ScheduleOptions.Builder builderForValue)

Options customizing the data transfer schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;

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

setState(TransferState value)

public TransferConfig.Builder setState(TransferState value)

Output only. State of the most recently updated transfer run.

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value TransferState

The state to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setStateValue(int value)

public TransferConfig.Builder setStateValue(int value)

Output only. State of the most recently updated transfer run.

.google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public TransferConfig.Builder setUpdateTime(Timestamp value)

Output only. Data transfer modification time. Ignored by server on input.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TransferConfig.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public TransferConfig.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Data transfer modification time. Ignored by server on input.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TransferConfig.Builder

setUserId(long value)

public TransferConfig.Builder setUserId(long value)

Deprecated. Unique ID of the user on whose behalf transfer is done.

int64 user_id = 11;

Parameter
Name Description
value long

The userId to set.
Returns
Type Description
TransferConfig.Builder

This builder for chaining.