TransferConfig class

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.


TransferConfig.fromJson(Map _json)


dataRefreshWindowDays 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.
read / write
datasetRegion String
Output only. Region in which BigQuery dataset is located.
read / write
dataSourceId String
Data source id. Cannot be changed once data transfer is created.
read / write
destinationDatasetId String
The BigQuery target dataset id.
read / write
disabled bool
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
read / write
displayName String
User specified display name for the data transfer.
read / write
emailPreferences EmailPreferences
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
name String
The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
read / write
nextRunTime String
Output only. Next time when data transfer will run.
read / write
notificationPubsubTopic String
Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
read / write
params Map<String, Object>
Data transfer specific parameters. [...]
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
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: NOTE: the granularity should be at least 8 hours, or less frequent.
read / write
scheduleOptions ScheduleOptions
Options customizing the data transfer schedule.
read / write
state String
Output only. State of the most recently updated transfer run. Possible string values are: [...]
read / write
updateTime String
Output only. Data transfer modification time. Ignored by server on input.
read / write
userId String
Deprecated. Unique ID of the user on whose behalf transfer is done.
read / write


noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toJson() Map<String, Object>
toString() String
Returns a string representation of this object.


operator ==(dynamic other) bool
The equality operator. [...]