- 2.48.0 (latest)
- 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 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
TransferConfigOrBuilderMethods
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. Cannot be changed once data transfer is created.
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 |
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 granularity should be at least 8 hours, or less frequent.
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. Cannot be changed once data transfer is created.
string data_source_id = 5;
Type | Description |
String | The dataSourceId. |
getDataSourceIdBytes()
public ByteString getDataSourceIdBytes()
Data source id. Cannot be changed once data transfer is created.
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 |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
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. |
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 granularity should be at least 8 hours, or less frequent.
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 granularity should be at least 8 hours, or less frequent.
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()
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 |
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];
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];
Type | Description |
TimestampOrBuilder |
getUserId()
public long getUserId()
Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
Type | Description |
long | The userId. |
hasDestinationDatasetId()
public boolean hasDestinationDatasetId()
The BigQuery target dataset id.
string destination_dataset_id = 2;
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;
Type | Description |
boolean | Whether the emailPreferences 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];
Type | Description |
boolean | Whether the nextRunTime 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;
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;
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];
Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
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;
Name | Description |
value | EmailPreferences |
Type | Description |
TransferConfig.Builder |
mergeFrom(TransferConfig other)
public TransferConfig.Builder mergeFrom(TransferConfig other)
Name | Description |
other | TransferConfig |
Type | Description |
TransferConfig.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransferConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
TransferConfig.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public TransferConfig.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
TransferConfig.Builder |
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];
Name | Description |
value | Timestamp |
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;
Name | Description |
value | Struct |
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;
Name | Description |
value | ScheduleOptions |
Type | Description |
TransferConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransferConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
TransferConfig.Builder |
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];
Name | Description |
value | Timestamp |
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;
Name | Description |
value | int The dataRefreshWindowDays to set. |
Type | Description |
TransferConfig.Builder | This builder for chaining. |
setDataSourceId(String value)
public TransferConfig.Builder setDataSourceId(String value)
Data source id. Cannot be changed once data transfer is created.
string data_source_id = 5;
Name | Description |
value | String The dataSourceId to set. |
Type | Description |
TransferConfig.Builder | This builder for chaining. |
setDataSourceIdBytes(ByteString value)
public TransferConfig.Builder setDataSourceIdBytes(ByteString value)
Data source id. Cannot be changed once data transfer is created.
string data_source_id = 5;
Name | Description |
value | ByteString The bytes for dataSourceId to set. |
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];
Name | Description |
value | String The datasetRegion to set. |
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];
Name | Description |
value | ByteString The bytes for datasetRegion to set. |
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;
Name | Description |
value | String The destinationDatasetId to set. |
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;
Name | Description |
value | ByteString The bytes for destinationDatasetId to set. |
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 are scheduled for a given transfer.
bool disabled = 13;
Name | Description |
value | boolean The disabled to set. |
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;
Name | Description |
value | String The displayName to set. |
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;
Name | Description |
value | ByteString The bytes for displayName to set. |
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;
Name | Description |
value | EmailPreferences |
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;
Name | Description |
builderForValue | EmailPreferences.Builder |
Type | Description |
TransferConfig.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public TransferConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
TransferConfig.Builder |
setName(String value)
public TransferConfig.Builder setName(String value)
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;
Name | Description |
value | String The name to set. |
Type | Description |
TransferConfig.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public TransferConfig.Builder setNameBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for name to set. |
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];
Name | Description |
value | Timestamp |
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];
Name | Description |
builderForValue | Builder |
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}/topics/{topic}
string notification_pubsub_topic = 15;
Name | Description |
value | String The notificationPubsubTopic to set. |
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}/topics/{topic}
string notification_pubsub_topic = 15;
Name | Description |
value | ByteString The bytes for notificationPubsubTopic to set. |
Type | Description |
TransferConfig.Builder | This builder for chaining. |
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;
Name | Description |
value | Struct |
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;
Name | Description |
builderForValue | Builder |
Type | Description |
TransferConfig.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TransferConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
TransferConfig.Builder |
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 granularity should be at least 8 hours, or less frequent.
string schedule = 7;
Name | Description |
value | String The schedule to set. |
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 granularity should be at least 8 hours, or less frequent.
string schedule = 7;
Name | Description |
value | ByteString The bytes for schedule to set. |
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;
Name | Description |
value | ScheduleOptions |
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;
Name | Description |
builderForValue | ScheduleOptions.Builder |
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];
Name | Description |
value | TransferState The state to set. |
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];
Name | Description |
value | int The enum numeric value on the wire for state to set. |
Type | Description |
TransferConfig.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final TransferConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
TransferConfig.Builder |
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];
Name | Description |
value | Timestamp |
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];
Name | Description |
builderForValue | Builder |
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;
Name | Description |
value | long The userId to set. |
Type | Description |
TransferConfig.Builder | This builder for chaining. |