Reference documentation and code samples for the BigQuery Data Transfer V1 Client class TransferConfig.
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.
Generated from protobuf message google.cloud.bigquery.datatransfer.v1.TransferConfig
Namespace
Google \ Cloud \ BigQuery \ DataTransfer \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
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.
↳ destination_dataset_id
string
The BigQuery target dataset id.
↳ display_name
string
User specified display name for the data transfer.
↳ data_source_id
string
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
↳ params
Google\Protobuf\Struct
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
↳ schedule
string
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.
↳ schedule_options
↳ schedule_options_v2
ScheduleOptionsV2
Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
↳ data_refresh_window_days
int
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.
↳ disabled
bool
Is this config disabled. When set to true, no runs will be scheduled for this transfer config.
↳ update_time
↳ next_run_time
↳ state
int
Output only. State of the most recently updated transfer run.
↳ user_id
int|string
Deprecated. Unique ID of the user on whose behalf transfer is done.
↳ dataset_region
string
Output only. Region in which BigQuery dataset is located.
↳ notification_pubsub_topic
string
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}
↳ email_preferences
EmailPreferences
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
↳ owner_info
UserInfo
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.
↳ encryption_configuration
EncryptionConfiguration
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.
↳ error
Google\Rpc\Status
Output only. Error code with detailed information about reason of the latest config failure.
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
setName
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.
var
string
$this
getDestinationDatasetId
The BigQuery target dataset id.
string
hasDestinationDatasetId
setDestinationDatasetId
The BigQuery target dataset id.
var
string
$this
getDisplayName
User specified display name for the data transfer.
string
setDisplayName
User specified display name for the data transfer.
var
string
$this
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
setDataSourceId
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
var
string
$this
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
hasParams
clearParams
setParams
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
$this
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
setSchedule
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.
var
string
$this
getScheduleOptions
Options customizing the data transfer schedule.
hasScheduleOptions
clearScheduleOptions
setScheduleOptions
Options customizing the data transfer schedule.
$this
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.
hasScheduleOptionsV2
clearScheduleOptionsV2
setScheduleOptionsV2
Options customizing different types of data transfer schedule.
This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
$this
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.
int
setDataRefreshWindowDays
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.
var
int
$this
getDisabled
Is this config disabled. When set to true, no runs will be scheduled for this transfer config.
bool
setDisabled
Is this config disabled. When set to true, no runs will be scheduled for this transfer config.
var
bool
$this
getUpdateTime
Output only. Data transfer modification time. Ignored by server on input.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Data transfer modification time. Ignored by server on input.
$this
getNextRunTime
Output only. Next time when data transfer will run.
hasNextRunTime
clearNextRunTime
setNextRunTime
Output only. Next time when data transfer will run.
$this
getState
Output only. State of the most recently updated transfer run.
int
setState
Output only. State of the most recently updated transfer run.
var
int
$this
getUserId
Deprecated. Unique ID of the user on whose behalf transfer is done.
int|string
setUserId
Deprecated. Unique ID of the user on whose behalf transfer is done.
var
int|string
$this
getDatasetRegion
Output only. Region in which BigQuery dataset is located.
string
setDatasetRegion
Output only. Region in which BigQuery dataset is located.
var
string
$this
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
setNotificationPubsubTopic
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}
var
string
$this
getEmailPreferences
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
hasEmailPreferences
clearEmailPreferences
setEmailPreferences
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
$this
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.
hasOwnerInfo
clearOwnerInfo
setOwnerInfo
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.
$this
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.
hasEncryptionConfiguration
clearEncryptionConfiguration
setEncryptionConfiguration
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.
$this
getError
Output only. Error code with detailed information about reason of the latest config failure.
hasError
clearError
setError
Output only. Error code with detailed information about reason of the latest config failure.
$this
getDestination
string
