REST Resource: projects.locations.transferConfigs

• Resource: TransferConfig
  • JSON representation
  • ScheduleOptions
    • JSON representation
• Methods

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 (ScheduleOptions) }, "dataRefreshWindowDays": number, "disabled": boolean, "updateTime": string, "nextRunTime": string, "state": enum (TransferState), "userId": string, "datasetRegion": string, "destinationDatasetId": string }

Fields
name	string The resource name of the transfer config. Transfer config names have the form of projects/{projectId}/locations/{region}/transferConfigs/{configId}. The name is automatically generated based on the configId specified in CreateTransferConfigRequest along with projectId and region. If configId is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for configId.
displayName	string User specified display name for the data transfer.
dataSourceId	string Data source id. Cannot be changed once data transfer is created.
params	object (Struct format) Data transfer specific parameters.
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 granularity should be at least 8 hours, or less frequent.
scheduleOptions	object (ScheduleOptions) Options customizing the data transfer schedule.
dataRefreshWindowDays	number The number of days to look back to automatically refresh the data. For example, if dataRefreshWindowDays = 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	boolean Is this config disabled. When set to true, no runs are scheduled for a given transfer.
updateTime	string (Timestamp format) Output only. Data transfer modification time. Ignored by server on input.
nextRunTime	string (Timestamp format) Output only. Next time when data transfer will run.
state	enum (TransferState) Output only. State of the most recently updated transfer run.
userId	string (int64 format) Deprecated. Unique ID of the user on whose behalf transfer is done.
datasetRegion	string Output only. Region in which BigQuery dataset is located.
destinationDatasetId	string The BigQuery target dataset id.

ScheduleOptions

Options customizing the data transfer schedule.

JSON representation
{ "disableAutoScheduling": boolean, "startTime": string, "endTime": string }

Fields
disableAutoScheduling	boolean 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	string (Timestamp format) 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	string (Timestamp format) 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
create	Creates a new data transfer configuration.
delete	Deletes a data transfer configuration, including any associated transfer runs and logs.
get	Returns information about a data transfer config.
list	Returns information about all data transfers in the project.
patch	Updates a data transfer configuration.
scheduleRuns (deprecated)	Creates transfer runs for a time range [start_time, end_time].
startManualRuns	Start manual transfer runs to be executed now with schedule_time equal to current time.