REST Resource: projects.transferConfigs.runs

Resource: TransferRun

Represents a data transfer run.

JSON representation
{"name":string,"scheduleTime":string,"runTime":string,"errorStatus":{object (Status)},"startTime":string,"endTime":string,"updateTime":string,"params":{object},"dataSourceId":string,"state":enum (TransferState),"userId":string,"schedule":string,"notificationPubsubTopic":string,"emailPreferences":{object (EmailPreferences)},// Union fielddestination can be only one of the following:"destinationDatasetId":string// End of list of possible types for union fielddestination.}
Fields
name

string

Identifier. The resource name of the transfer run. Transfer run names have the formprojects/{projectId}/locations/{location}/transferConfigs/{configId}/runs/{run_id}. The name is ignored when creating a transfer run.

scheduleTime

string (Timestamp format)

Minimum time after which a transfer run can be started.

runTime

string (Timestamp format)

For batch transfer runs, specifies the date and time of the data should be ingested.

errorStatus

object (Status)

Status of the transfer run.

startTime

string (Timestamp format)

Output only. Time when transfer run was started. Parameter ignored by server for input requests.

endTime

string (Timestamp format)

Output only. Time when transfer run ended. Parameter ignored by server for input requests.

updateTime

string (Timestamp format)

Output only. Last time the data transfer run state was updated.

params

object (Struct format)

Output only. 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

dataSourceId

string

Output only. Data source id.

state

enum (TransferState)

Data transfer run state. Ignored for input requests.

userId

string (int64 format)

Deprecated. Unique ID of the user on whose behalf transfer is done.

schedule

string

Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, soscheduleTime doesn't always match this.

notificationPubsubTopic

string

Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes.

The format for specifying a pubsub topic is:projects/{projectId}/topics/{topic_id}

emailPreferences

object (EmailPreferences)

Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.

Union fielddestination. Data transfer destination.destination can be only one of the following:
destinationDatasetId

string

Output only. The BigQuery target dataset id.

Methods

delete

 Deletes the specified transfer run.

get

 Returns information about the particular transfer run.

list

 Returns information about running and completed transfer runs.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-02 UTC.