public static final class TransferConfig.Builder extends com.google.protobuf.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| Modifier and Type | Method and Description |
|---|---|
TransferConfig.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
TransferConfig |
build() |
TransferConfig |
buildPartial() |
TransferConfig.Builder |
clear() |
TransferConfig.Builder |
clearDataRefreshWindowDays()
The number of days to look back to automatically refresh the data.
|
TransferConfig.Builder |
clearDatasetRegion()
Output only.
|
TransferConfig.Builder |
clearDataSourceId()
Data source ID.
|
TransferConfig.Builder |
clearDestination() |
TransferConfig.Builder |
clearDestinationDatasetId()
The BigQuery target dataset id.
|
TransferConfig.Builder |
clearDisabled()
Is this config disabled.
|
TransferConfig.Builder |
clearDisplayName()
User specified display name for the data transfer.
|
TransferConfig.Builder |
clearEmailPreferences()
Email notifications will be sent according to these preferences
to the email address of the user who owns this transfer config.
|
TransferConfig.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
TransferConfig.Builder |
clearName()
The resource name of the transfer config.
|
TransferConfig.Builder |
clearNextRunTime()
Output only.
|
TransferConfig.Builder |
clearNotificationPubsubTopic()
Pub/Sub topic where notifications will be sent after transfer runs
associated with this transfer config finish.
|
TransferConfig.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
TransferConfig.Builder |
clearOwnerInfo()
Output only.
|
TransferConfig.Builder |
clearParams()
Parameters specific to each data source.
|
TransferConfig.Builder |
clearSchedule()
Data transfer schedule.
|
TransferConfig.Builder |
clearScheduleOptions()
Options customizing the data transfer schedule.
|
TransferConfig.Builder |
clearState()
Output only.
|
TransferConfig.Builder |
clearUpdateTime()
Output only.
|
TransferConfig.Builder |
clearUserId()
Deprecated.
|
TransferConfig.Builder |
clone() |
int |
getDataRefreshWindowDays()
The number of days to look back to automatically refresh the data.
|
String |
getDatasetRegion()
Output only.
|
com.google.protobuf.ByteString |
getDatasetRegionBytes()
Output only.
|
String |
getDataSourceId()
Data source ID.
|
com.google.protobuf.ByteString |
getDataSourceIdBytes()
Data source ID.
|
TransferConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
TransferConfig.DestinationCase |
getDestinationCase() |
String |
getDestinationDatasetId()
The BigQuery target dataset id.
|
com.google.protobuf.ByteString |
getDestinationDatasetIdBytes()
The BigQuery target dataset id.
|
boolean |
getDisabled()
Is this config disabled.
|
String |
getDisplayName()
User specified display name for the data transfer.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
User specified display name for the data transfer.
|
EmailPreferences |
getEmailPreferences()
Email notifications will be sent according to these preferences
to the email address of the user who owns this transfer config.
|
EmailPreferences.Builder |
getEmailPreferencesBuilder()
Email notifications will be sent according to these preferences
to the email address of the user who owns this transfer config.
|
EmailPreferencesOrBuilder |
getEmailPreferencesOrBuilder()
Email notifications will be sent according to these preferences
to the email address of the user who owns this transfer config.
|
String |
getName()
The resource name of the transfer config.
|
com.google.protobuf.ByteString |
getNameBytes()
The resource name of the transfer config.
|
com.google.protobuf.Timestamp |
getNextRunTime()
Output only.
|
com.google.protobuf.Timestamp.Builder |
getNextRunTimeBuilder()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getNextRunTimeOrBuilder()
Output only.
|
String |
getNotificationPubsubTopic()
Pub/Sub topic where notifications will be sent after transfer runs
associated with this transfer config finish.
|
com.google.protobuf.ByteString |
getNotificationPubsubTopicBytes()
Pub/Sub topic where notifications will be sent after transfer runs
associated with this transfer config finish.
|
UserInfo |
getOwnerInfo()
Output only.
|
UserInfo.Builder |
getOwnerInfoBuilder()
Output only.
|
UserInfoOrBuilder |
getOwnerInfoOrBuilder()
Output only.
|
com.google.protobuf.Struct |
getParams()
Parameters specific to each data source.
|
com.google.protobuf.Struct.Builder |
getParamsBuilder()
Parameters specific to each data source.
|
com.google.protobuf.StructOrBuilder |
getParamsOrBuilder()
Parameters specific to each data source.
|
String |
getSchedule()
Data transfer schedule.
|
com.google.protobuf.ByteString |
getScheduleBytes()
Data transfer schedule.
|
ScheduleOptions |
getScheduleOptions()
Options customizing the data transfer schedule.
|
ScheduleOptions.Builder |
getScheduleOptionsBuilder()
Options customizing the data transfer schedule.
|
ScheduleOptionsOrBuilder |
getScheduleOptionsOrBuilder()
Options customizing the data transfer schedule.
|
TransferState |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.Timestamp.Builder |
getUpdateTimeBuilder()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
long |
getUserId()
Deprecated.
|
boolean |
hasDestinationDatasetId()
The BigQuery target dataset id.
|
boolean |
hasEmailPreferences()
Email notifications will be sent according to these preferences
to the email address of the user who owns this transfer config.
|
boolean |
hasNextRunTime()
Output only.
|
boolean |
hasOwnerInfo()
Output only.
|
boolean |
hasParams()
Parameters specific to each data source.
|
boolean |
hasScheduleOptions()
Options customizing the data transfer schedule.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
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.
|
TransferConfig.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
TransferConfig.Builder |
mergeFrom(com.google.protobuf.Message other) |
TransferConfig.Builder |
mergeFrom(TransferConfig other) |
TransferConfig.Builder |
mergeNextRunTime(com.google.protobuf.Timestamp value)
Output only.
|
TransferConfig.Builder |
mergeOwnerInfo(UserInfo value)
Output only.
|
TransferConfig.Builder |
mergeParams(com.google.protobuf.Struct value)
Parameters specific to each data source.
|
TransferConfig.Builder |
mergeScheduleOptions(ScheduleOptions value)
Options customizing the data transfer schedule.
|
TransferConfig.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
TransferConfig.Builder |
mergeUpdateTime(com.google.protobuf.Timestamp value)
Output only.
|
TransferConfig.Builder |
setDataRefreshWindowDays(int value)
The number of days to look back to automatically refresh the data.
|
TransferConfig.Builder |
setDatasetRegion(String value)
Output only.
|
TransferConfig.Builder |
setDatasetRegionBytes(com.google.protobuf.ByteString value)
Output only.
|
TransferConfig.Builder |
setDataSourceId(String value)
Data source ID.
|
TransferConfig.Builder |
setDataSourceIdBytes(com.google.protobuf.ByteString value)
Data source ID.
|
TransferConfig.Builder |
setDestinationDatasetId(String value)
The BigQuery target dataset id.
|
TransferConfig.Builder |
setDestinationDatasetIdBytes(com.google.protobuf.ByteString value)
The BigQuery target dataset id.
|
TransferConfig.Builder |
setDisabled(boolean value)
Is this config disabled.
|
TransferConfig.Builder |
setDisplayName(String value)
User specified display name for the data transfer.
|
TransferConfig.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
User specified display name for the data transfer.
|
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.
|
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.
|
TransferConfig.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
TransferConfig.Builder |
setName(String value)
The resource name of the transfer config.
|
TransferConfig.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The resource name of the transfer config.
|
TransferConfig.Builder |
setNextRunTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
TransferConfig.Builder |
setNextRunTime(com.google.protobuf.Timestamp value)
Output only.
|
TransferConfig.Builder |
setNotificationPubsubTopic(String value)
Pub/Sub topic where notifications will be sent after transfer runs
associated with this transfer config finish.
|
TransferConfig.Builder |
setNotificationPubsubTopicBytes(com.google.protobuf.ByteString value)
Pub/Sub topic where notifications will be sent after transfer runs
associated with this transfer config finish.
|
TransferConfig.Builder |
setOwnerInfo(UserInfo.Builder builderForValue)
Output only.
|
TransferConfig.Builder |
setOwnerInfo(UserInfo value)
Output only.
|
TransferConfig.Builder |
setParams(com.google.protobuf.Struct.Builder builderForValue)
Parameters specific to each data source.
|
TransferConfig.Builder |
setParams(com.google.protobuf.Struct value)
Parameters specific to each data source.
|
TransferConfig.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
TransferConfig.Builder |
setSchedule(String value)
Data transfer schedule.
|
TransferConfig.Builder |
setScheduleBytes(com.google.protobuf.ByteString value)
Data transfer schedule.
|
TransferConfig.Builder |
setScheduleOptions(ScheduleOptions.Builder builderForValue)
Options customizing the data transfer schedule.
|
TransferConfig.Builder |
setScheduleOptions(ScheduleOptions value)
Options customizing the data transfer schedule.
|
TransferConfig.Builder |
setState(TransferState value)
Output only.
|
TransferConfig.Builder |
setStateValue(int value)
Output only.
|
TransferConfig.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
TransferConfig.Builder |
setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
TransferConfig.Builder |
setUpdateTime(com.google.protobuf.Timestamp value)
Output only.
|
TransferConfig.Builder |
setUserId(long value)
Deprecated.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic TransferConfig build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic TransferConfig buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic TransferConfig.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferConfig.Builder>public TransferConfig.Builder mergeFrom(TransferConfig other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public TransferConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferConfig.Builder>IOExceptionpublic TransferConfig.DestinationCase getDestinationCase()
getDestinationCase in interface TransferConfigOrBuilderpublic TransferConfig.Builder clearDestination()
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;getName in interface TransferConfigOrBuilderpublic com.google.protobuf.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;getNameBytes in interface TransferConfigOrBuilderpublic 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;value - The name to set.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;public TransferConfig.Builder setNameBytes(com.google.protobuf.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;value - The bytes for name to set.public boolean hasDestinationDatasetId()
The BigQuery target dataset id.
string destination_dataset_id = 2;hasDestinationDatasetId in interface TransferConfigOrBuilderpublic String getDestinationDatasetId()
The BigQuery target dataset id.
string destination_dataset_id = 2;getDestinationDatasetId in interface TransferConfigOrBuilderpublic com.google.protobuf.ByteString getDestinationDatasetIdBytes()
The BigQuery target dataset id.
string destination_dataset_id = 2;getDestinationDatasetIdBytes in interface TransferConfigOrBuilderpublic TransferConfig.Builder setDestinationDatasetId(String value)
The BigQuery target dataset id.
string destination_dataset_id = 2;value - The destinationDatasetId to set.public TransferConfig.Builder clearDestinationDatasetId()
The BigQuery target dataset id.
string destination_dataset_id = 2;public TransferConfig.Builder setDestinationDatasetIdBytes(com.google.protobuf.ByteString value)
The BigQuery target dataset id.
string destination_dataset_id = 2;value - The bytes for destinationDatasetId to set.public String getDisplayName()
User specified display name for the data transfer.
string display_name = 3;getDisplayName in interface TransferConfigOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
User specified display name for the data transfer.
string display_name = 3;getDisplayNameBytes in interface TransferConfigOrBuilderpublic TransferConfig.Builder setDisplayName(String value)
User specified display name for the data transfer.
string display_name = 3;value - The displayName to set.public TransferConfig.Builder clearDisplayName()
User specified display name for the data transfer.
string display_name = 3;public TransferConfig.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
User specified display name for the data transfer.
string display_name = 3;value - The bytes for displayName to set.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;getDataSourceId in interface TransferConfigOrBuilderpublic com.google.protobuf.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;getDataSourceIdBytes in interface TransferConfigOrBuilderpublic 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;value - The dataSourceId to set.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;public TransferConfig.Builder setDataSourceIdBytes(com.google.protobuf.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;value - The bytes for dataSourceId to set.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;hasParams in interface TransferConfigOrBuilderpublic com.google.protobuf.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;getParams in interface TransferConfigOrBuilderpublic TransferConfig.Builder setParams(com.google.protobuf.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;public TransferConfig.Builder setParams(com.google.protobuf.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;public TransferConfig.Builder mergeParams(com.google.protobuf.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;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;public com.google.protobuf.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;public com.google.protobuf.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;getParamsOrBuilder in interface TransferConfigOrBuilderpublic 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;getSchedule in interface TransferConfigOrBuilderpublic com.google.protobuf.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;getScheduleBytes in interface TransferConfigOrBuilderpublic 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;value - The schedule to set.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;public TransferConfig.Builder setScheduleBytes(com.google.protobuf.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;value - The bytes for schedule to set.public boolean hasScheduleOptions()
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;hasScheduleOptions in interface TransferConfigOrBuilderpublic ScheduleOptions getScheduleOptions()
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;getScheduleOptions in interface TransferConfigOrBuilderpublic TransferConfig.Builder setScheduleOptions(ScheduleOptions value)
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;public TransferConfig.Builder setScheduleOptions(ScheduleOptions.Builder builderForValue)
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;public TransferConfig.Builder mergeScheduleOptions(ScheduleOptions value)
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;public TransferConfig.Builder clearScheduleOptions()
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;public ScheduleOptions.Builder getScheduleOptionsBuilder()
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;public ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder()
Options customizing the data transfer schedule.
.google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;getScheduleOptionsOrBuilder in interface TransferConfigOrBuilderpublic 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;getDataRefreshWindowDays in interface TransferConfigOrBuilderpublic 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;value - The dataRefreshWindowDays to set.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;public boolean getDisabled()
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
bool disabled = 13;getDisabled in interface TransferConfigOrBuilderpublic TransferConfig.Builder setDisabled(boolean value)
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
bool disabled = 13;value - The disabled to set.public TransferConfig.Builder clearDisabled()
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
bool disabled = 13;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];
hasUpdateTime in interface TransferConfigOrBuilderpublic com.google.protobuf.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];
getUpdateTime in interface TransferConfigOrBuilderpublic TransferConfig.Builder setUpdateTime(com.google.protobuf.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];
public TransferConfig.Builder setUpdateTime(com.google.protobuf.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];
public TransferConfig.Builder mergeUpdateTime(com.google.protobuf.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];
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];
public com.google.protobuf.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];
public com.google.protobuf.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];
getUpdateTimeOrBuilder in interface TransferConfigOrBuilderpublic boolean hasNextRunTime()
Output only. Next time when data transfer will run.
.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasNextRunTime in interface TransferConfigOrBuilderpublic com.google.protobuf.Timestamp getNextRunTime()
Output only. Next time when data transfer will run.
.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNextRunTime in interface TransferConfigOrBuilderpublic TransferConfig.Builder setNextRunTime(com.google.protobuf.Timestamp value)
Output only. Next time when data transfer will run.
.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TransferConfig.Builder setNextRunTime(com.google.protobuf.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];
public TransferConfig.Builder mergeNextRunTime(com.google.protobuf.Timestamp value)
Output only. Next time when data transfer will run.
.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
public com.google.protobuf.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];
public com.google.protobuf.TimestampOrBuilder getNextRunTimeOrBuilder()
Output only. Next time when data transfer will run.
.google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNextRunTimeOrBuilder in interface TransferConfigOrBuilderpublic 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];
getStateValue in interface TransferConfigOrBuilderpublic 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];
value - The enum numeric value on the wire for state to set.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];
getState in interface TransferConfigOrBuilderpublic 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];
value - The state to set.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];
public long getUserId()
Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;getUserId in interface TransferConfigOrBuilderpublic TransferConfig.Builder setUserId(long value)
Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;value - The userId to set.public TransferConfig.Builder clearUserId()
Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;public String getDatasetRegion()
Output only. Region in which BigQuery dataset is located.
string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];getDatasetRegion in interface TransferConfigOrBuilderpublic com.google.protobuf.ByteString getDatasetRegionBytes()
Output only. Region in which BigQuery dataset is located.
string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];getDatasetRegionBytes in interface TransferConfigOrBuilderpublic TransferConfig.Builder setDatasetRegion(String value)
Output only. Region in which BigQuery dataset is located.
string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The datasetRegion to set.public TransferConfig.Builder clearDatasetRegion()
Output only. Region in which BigQuery dataset is located.
string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];public TransferConfig.Builder setDatasetRegionBytes(com.google.protobuf.ByteString value)
Output only. Region in which BigQuery dataset is located.
string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The bytes for datasetRegion to set.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;getNotificationPubsubTopic in interface TransferConfigOrBuilderpublic com.google.protobuf.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;getNotificationPubsubTopicBytes in interface TransferConfigOrBuilderpublic 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;value - The notificationPubsubTopic to set.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;public TransferConfig.Builder setNotificationPubsubTopicBytes(com.google.protobuf.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;value - The bytes for notificationPubsubTopic to set.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;hasEmailPreferences in interface TransferConfigOrBuilderpublic 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;getEmailPreferences in interface TransferConfigOrBuilderpublic 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;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;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;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;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;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;getEmailPreferencesOrBuilder in interface TransferConfigOrBuilderpublic 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];
hasOwnerInfo in interface TransferConfigOrBuilderpublic 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];
getOwnerInfo in interface TransferConfigOrBuilderpublic 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];
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];
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];
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];
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];
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];
getOwnerInfoOrBuilder in interface TransferConfigOrBuilderpublic final TransferConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>public final TransferConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>Copyright © 2023 Google LLC. All rights reserved.