Resource: TransferConfig
Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destinationDatasetId
specifies where data should be stored. When a new transfer configuration is created, the specified destinationDatasetId
is created when needed and shared with the appropriate data source service account.
JSON representation | |
---|---|
{ "name": string, "displayName": string, "dataSourceId": string, "params": { object }, "schedule": string, "scheduleOptions": { object ( |
Fields | |
---|---|
name |
The resource name of the transfer config. Transfer config names have the form of |
displayName |
User specified display name for the data transfer. |
dataSourceId |
Data source id. Cannot be changed once data transfer is created. |
params |
Data transfer specific parameters. |
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: |
scheduleOptions |
Options customizing the data transfer schedule. |
dataRefreshWindowDays |
The number of days to look back to automatically refresh the data. For example, if |
disabled |
Is this config disabled. When set to true, no runs are scheduled for a given transfer. |
updateTime |
Output only. Data transfer modification time. Ignored by server on input. |
nextRunTime |
Output only. Next time when data transfer will run. |
state |
Output only. State of the most recently updated transfer run. |
userId |
Deprecated. Unique ID of the user on whose behalf transfer is done. |
datasetRegion |
Output only. Region in which BigQuery dataset is located. |
destinationDatasetId |
The BigQuery target dataset id. |
ScheduleOptions
Options customizing the data transfer schedule.
JSON representation | |
---|---|
{ "disableAutoScheduling": boolean, "startTime": string, "endTime": string } |
Fields | |
---|---|
disableAutoScheduling |
If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using transferConfigs.startManualRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored. |
startTime |
Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option. |
endTime |
Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option. |
Methods |
|
---|---|
|
Creates a new data transfer configuration. |
|
Deletes a data transfer configuration, including any associated transfer runs and logs. |
|
Returns information about a data transfer config. |
|
Returns information about all data transfers in the project. |
|
Updates a data transfer configuration. |
(deprecated) |
Creates transfer runs for a time range [start_time, end_time]. |
|
Start manual transfer runs to be executed now with schedule_time equal to current time. |