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.
Attributes
- dataRefreshWindowDays
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.- dataSourceId
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
- datasetRegion
Output only. Region in which BigQuery dataset is located.
- disabled
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
- displayName
User specified display name for the data transfer.
- emailPreferences
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
- name
The resource name of the transfer config. Transfer config names have the form
projects/{project_id}/locations/{region}/transferConfigs/{config_id}
. Whereconfig_id
is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.- nextRunTime
Output only. Next time when data transfer will run.
- notificationPubsubTopic
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}
- ownerInfo
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.- params
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
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
, andfirst 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.- scheduleOptions
Options customizing the data transfer schedule.
- state
Output only. State of the most recently updated transfer run.
- updateTime
Output only. Data transfer modification time. Ignored by server on input.
- userId
Deprecated. Unique ID of the user on whose behalf transfer is done.
- Companion:
- object
- Source:
- TransferConfig.scala
- Graph
- Supertypes
- trait Updatable[TransferConfig]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any