Collection: projects.transferConfigs

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,
  "destinationDatasetId": string,
  "displayName": string,
  "updateTime": string,
  "dataSourceId": string,
  "schedule": string,
  "nextRunTime": string,
  "params": {
    object
  },
  "status": enum(TransferStatus),
  "userId": string,
  "dataRefreshWindowDays": number,
  "disabled": boolean,
  "datasetRegion": string,
}
Fields
name

string

The resource name of the transfer run. Transfer run names have the form projects/{projectId}/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 run.

destinationDatasetId

string

The BigQuery target dataset id.

displayName

string

User specified display name for the data transfer.

updateTime

string (Timestamp format)

Data transfer modification time. Ignored by server on input.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Note: This field is used in responses only. Any value specified here in a request is ignored.

dataSourceId

string

Data source id. Cannot be changed once data transfer is created.

schedule

string

Data transfer schedule in GROC format. 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 GROC include: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00.

nextRunTime

string (Timestamp format)

Next time when data transfer will run. Output only. Applicable only for batch data transfers.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Note: This field is used in responses only. Any value specified here in a request is ignored.

params

object (Struct format)

Data transfer specific parameters.

status

enum(TransferStatus)

Status of the most recently updated transfer run.

Note: This field is used in responses only. Any value specified here in a request is ignored.

userId

string (int64 format)

GaiaID of the user on whose behalf transfer is done. Applicable only to data sources that do not support service accounts. When set to 0, the data source service account credentials are used.

Note: This field is used in responses only. Any value specified here in a request is ignored.

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.

datasetRegion

string

Region in which BigQuery dataset is located. Currently possible values are: "US" and "EU".

Note: This field is used in responses only. Any value specified here in a request is ignored.

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

Creates transfer runs for a time range [range_start_time, range_end_time].

Send feedback about...