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.BuilderImplements
TransferConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field | FieldDescriptor |
value | Object |
| Type | Description |
TransferConfig.Builder |
build()
public TransferConfig build()| Type | Description |
TransferConfig |
buildPartial()
public TransferConfig buildPartial()| Type | Description |
TransferConfig |
clear()
public TransferConfig.Builder clear()| Type | Description |
TransferConfig.Builder |
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;
| 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;
| 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];
| Type | Description |
TransferConfig.Builder | This builder for chaining. |
clearDestination()
public TransferConfig.Builder clearDestination()| Type | Description |
TransferConfig.Builder |
clearDestinationDatasetId()
public TransferConfig.Builder clearDestinationDatasetId()The BigQuery target dataset id.
string destination_dataset_id = 2;
| Type | Description |
TransferConfig.Builder | This builder for chaining. |
clearDisabled()
public TransferConfig.Builder clearDisabled()Is this config disabled. When set to true, no runs are scheduled for a given transfer.
bool disabled = 13;
| 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;
| 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;
| Type | Description |
TransferConfig.Builder |
clearField(Descriptors.FieldDescriptor field)
public TransferConfig.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
field | FieldDescriptor |
| Type | Description |
TransferConfig.Builder |
clearName()
public TransferConfig.Builder clearName() The resource name of the transfer config.
Transfer config names have the form
projects/{project_id}/locations/{region}/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;
| 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];
| 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}/topics/{topic}
string notification_pubsub_topic = 15;
| Type | Description |
TransferConfig.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
oneof | OneofDescriptor |
| Type | Description |
TransferConfig.Builder |
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];
| 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;
| 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;
| 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;
| 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];
| 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];
| 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;
| Type | Description |
TransferConfig.Builder | This builder for chaining. |
clone()
public TransferConfig.Builder clone()| Type | Description |
TransferConfig.Builder |
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;
| 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;
| 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;
| 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];
| 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];
| Type | Description |
ByteString | The bytes for datasetRegion. |
getDefaultInstanceForType()
public TransferConfig getDefaultInstanceForType()| Type | Description |
TransferConfig |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
Descriptor |
getDestinationCase()
public TransferConfig.DestinationCase getDestinationCase()| Type | Description |
TransferConfig.DestinationCase |
getDestinationDatasetId()
public String getDestinationDatasetId()The BigQuery target dataset id.
string destination_dataset_id = 2;
| Type | Description |
String | The destinationDatasetId. |
getDestinationDatasetIdBytes()
public ByteString getDestinationDatasetIdBytes()The BigQuery target dataset id.
string destination_dataset_id = 2;
| Type | Description |
ByteString | The bytes for destinationDatasetId. |
getDisabled()
public boolean getDisabled()Is this config disabled. When set to true, no runs are scheduled for a given transfer.
bool disabled = 13;
| Type | Description |
boolean | The disabled. |
getDisplayName()
public String getDisplayName()User specified display name for the data transfer.
string display_name = 3;
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()User specified display name for the data transfer.
string display_name = 3;
| 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;
| 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;
| 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;
| Type | Description |
EmailPreferencesOrBuilder |
getName()
public String getName() The resource name of the transfer config.
Transfer config names have the form
projects/{project_id}/locations/{region}/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;
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes() The resource name of the transfer config.
Transfer config names have the form
projects/{project_id}/locations/{region}/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;
| 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];
| 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];
| 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];
| 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}/topics/{topic}
string notification_pubsub_topic = 15;
| 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}/topics/{topic}
string notification_pubsub_topic = 15;
| 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];
| 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];
| 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];
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
ScheduleOptions.Builder |
getScheduleOptionsOrBuilder()
public ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder()Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
| 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];
| 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];
| Type | Description |
int | The enum numeric value on the wire for state. |
getUpdateTime()
public Timestamp getUpdateTime()