Interface TransferConfigOrBuilder (2.54.0) 

public interface TransferConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataRefreshWindowDays()

public abstract int getDataRefreshWindowDays()

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

int32 data_refresh_window_days = 12;

Returns
Type Description
int

The dataRefreshWindowDays.

getDataSourceId()

public abstract String getDataSourceId()

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

string data_source_id = 5;

Returns
Type Description
String

The dataSourceId.

getDataSourceIdBytes()

public abstract ByteString getDataSourceIdBytes()

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

string data_source_id = 5;

Returns
Type Description
ByteString

The bytes for dataSourceId.

getDatasetRegion()

public abstract String getDatasetRegion()

Output only. Region in which BigQuery dataset is located.

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

Returns
Type Description
String

The datasetRegion.

getDatasetRegionBytes()

public abstract ByteString getDatasetRegionBytes()

Output only. Region in which BigQuery dataset is located.

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

Returns
Type Description
ByteString

The bytes for datasetRegion.

getDestinationCase()

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

getDestinationDatasetId()

public abstract String getDestinationDatasetId()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
Type Description
String

The destinationDatasetId.

getDestinationDatasetIdBytes()

public abstract ByteString getDestinationDatasetIdBytes()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
Type Description
ByteString

The bytes for destinationDatasetId.

getDisabled()

public abstract boolean getDisabled()

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

bool disabled = 13;

Returns
Type Description
boolean

The disabled.

getDisplayName()

public abstract String getDisplayName()

User specified display name for the data transfer.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

User specified display name for the data transfer.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getEmailPreferences()

public abstract EmailPreferences getEmailPreferences()

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

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

Returns
Type Description
EmailPreferences

The emailPreferences.

getEmailPreferencesOrBuilder()

public abstract EmailPreferencesOrBuilder getEmailPreferencesOrBuilder()

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

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

Returns
Type Description
EmailPreferencesOrBuilder

getEncryptionConfiguration()

public abstract EncryptionConfiguration getEncryptionConfiguration()

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

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

Returns
Type Description
EncryptionConfiguration

The encryptionConfiguration.

getEncryptionConfigurationOrBuilder()

public abstract EncryptionConfigurationOrBuilder getEncryptionConfigurationOrBuilder()

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

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

Returns
Type Description
EncryptionConfigurationOrBuilder

getError()

public abstract Status getError()

Output only. Error code with detailed information about reason of the latest config failure.

.google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public abstract StatusOrBuilder getErrorOrBuilder()

Output only. Error code with detailed information about reason of the latest config failure.

.google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getName()

public abstract String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getNextRunTime()

public abstract Timestamp getNextRunTime()

Output only. Next time when data transfer will run.

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

Returns
Type Description
Timestamp

The nextRunTime.

getNextRunTimeOrBuilder()

public abstract TimestampOrBuilder getNextRunTimeOrBuilder()

Output only. Next time when data transfer will run.

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

Returns
Type Description
TimestampOrBuilder

getNotificationPubsubTopic()

public abstract String getNotificationPubsubTopic()

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

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

string notification_pubsub_topic = 15;

Returns
Type Description
String

The notificationPubsubTopic.

getNotificationPubsubTopicBytes()

public abstract ByteString getNotificationPubsubTopicBytes()

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

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

string notification_pubsub_topic = 15;

Returns
Type Description
ByteString

The bytes for notificationPubsubTopic.

getOwnerInfo()

public abstract UserInfo getOwnerInfo()

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

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

Returns
Type Description
UserInfo

The ownerInfo.

getOwnerInfoOrBuilder()

public abstract UserInfoOrBuilder getOwnerInfoOrBuilder()

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

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

Returns
Type Description
UserInfoOrBuilder

getParams()

public abstract Struct getParams()

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

.google.protobuf.Struct params = 9;

Returns
Type Description
Struct

The params.

getParamsOrBuilder()

public abstract StructOrBuilder getParamsOrBuilder()

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

.google.protobuf.Struct params = 9;

Returns
Type Description
StructOrBuilder

getSchedule()

public abstract String getSchedule()

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

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

string schedule = 7;

Returns
Type Description
String

The schedule.

getScheduleBytes()

public abstract ByteString getScheduleBytes()

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

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

string schedule = 7;

Returns
Type Description
ByteString

The bytes for schedule.

getScheduleOptions()

public abstract ScheduleOptions getScheduleOptions()

Options customizing the data transfer schedule.

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

Returns
Type Description
ScheduleOptions

The scheduleOptions.

getScheduleOptionsOrBuilder()

public abstract ScheduleOptionsOrBuilder getScheduleOptionsOrBuilder()

Options customizing the data transfer schedule.

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

Returns
Type Description
ScheduleOptionsOrBuilder

getScheduleOptionsV2()

public abstract ScheduleOptionsV2 getScheduleOptionsV2()

Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31;

Returns
Type Description
ScheduleOptionsV2

The scheduleOptionsV2.

getScheduleOptionsV2OrBuilder()

public abstract ScheduleOptionsV2OrBuilder getScheduleOptionsV2OrBuilder()

Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31;

Returns
Type Description
ScheduleOptionsV2OrBuilder

getState()

public abstract TransferState getState()

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

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

Returns
Type Description
TransferState

The state.

getStateValue()

public abstract int getStateValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getUserId()

public abstract long getUserId()

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

int64 user_id = 11;

Returns
Type Description
long

The userId.

hasDestinationDatasetId()

public abstract boolean hasDestinationDatasetId()

The BigQuery target dataset id.

string destination_dataset_id = 2;

Returns
Type Description
boolean

Whether the destinationDatasetId field is set.

hasEmailPreferences()

public abstract boolean hasEmailPreferences()

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

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

Returns
Type Description
boolean

Whether the emailPreferences field is set.

hasEncryptionConfiguration()

public abstract boolean hasEncryptionConfiguration()

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

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

Returns
Type Description
boolean

Whether the encryptionConfiguration field is set.

hasError()

public abstract boolean hasError()

Output only. Error code with detailed information about reason of the latest config failure.

.google.rpc.Status error = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the error field is set.

hasNextRunTime()

public abstract boolean hasNextRunTime()

Output only. Next time when data transfer will run.

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

Returns
Type Description
boolean

Whether the nextRunTime field is set.

hasOwnerInfo()

public abstract boolean hasOwnerInfo()

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

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

Returns
Type Description
boolean

Whether the ownerInfo field is set.

hasParams()

public abstract boolean hasParams()

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

.google.protobuf.Struct params = 9;

Returns
Type Description
boolean

Whether the params field is set.

hasScheduleOptions()

public abstract boolean hasScheduleOptions()

Options customizing the data transfer schedule.

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

Returns
Type Description
boolean

Whether the scheduleOptions field is set.

hasScheduleOptionsV2()

public abstract boolean hasScheduleOptionsV2()

Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 schedule_options_v2 = 31;

Returns
Type Description
boolean

Whether the scheduleOptionsV2 field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

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

Returns
Type Description
boolean

Whether the updateTime field is set.