runs

Creates, updates, deletes, gets or lists a runs resource.

Overview

Name	runs
Type	Resource
Id	google.bigquerydatatransfer.runs

Fields

The following fields are returned by SELECT queries:

projects_locations_transfer_configs_runs_get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the transfer run. Transfer run names have the form projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.
dataSourceId	string	Output only. Data source id.
destinationDatasetId	string	Output only. The BigQuery target dataset id.
emailPreferences	object	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. (id: EmailPreferences)
endTime	string (google-datetime)	Output only. Time when transfer run ended. Parameter ignored by server for input requests.
errorStatus	object	Status of the transfer run. (id: Status)
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/{project_id}/topics/{topic_id}
params	object	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
runTime	string (google-datetime)	For batch transfer runs, specifies the date and time of the data should be ingested.
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, so schedule_time doesn't always match this.
scheduleTime	string (google-datetime)	Minimum time after which a transfer run can be started.
startTime	string (google-datetime)	Output only. Time when transfer run was started. Parameter ignored by server for input requests.
state	string	Data transfer run state. Ignored for input requests.
updateTime	string (google-datetime)	Output only. Last time the data transfer run state was updated.
userId	string (int64)	Deprecated. Unique ID of the user on whose behalf transfer is done.

projects_transfer_configs_runs_get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the transfer run. Transfer run names have the form projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.
dataSourceId	string	Output only. Data source id.
destinationDatasetId	string	Output only. The BigQuery target dataset id.
emailPreferences	object	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. (id: EmailPreferences)
endTime	string (google-datetime)	Output only. Time when transfer run ended. Parameter ignored by server for input requests.
errorStatus	object	Status of the transfer run. (id: Status)
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/{project_id}/topics/{topic_id}
params	object	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
runTime	string (google-datetime)	For batch transfer runs, specifies the date and time of the data should be ingested.
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, so schedule_time doesn't always match this.
scheduleTime	string (google-datetime)	Minimum time after which a transfer run can be started.
startTime	string (google-datetime)	Output only. Time when transfer run was started. Parameter ignored by server for input requests.
state	string	Data transfer run state. Ignored for input requests.
updateTime	string (google-datetime)	Output only. Last time the data transfer run state was updated.
userId	string (int64)	Deprecated. Unique ID of the user on whose behalf transfer is done.

projects_locations_transfer_configs_runs_list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the transfer run. Transfer run names have the form projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.
dataSourceId	string	Output only. Data source id.
destinationDatasetId	string	Output only. The BigQuery target dataset id.
emailPreferences	object	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. (id: EmailPreferences)
endTime	string (google-datetime)	Output only. Time when transfer run ended. Parameter ignored by server for input requests.
errorStatus	object	Status of the transfer run. (id: Status)
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/{project_id}/topics/{topic_id}
params	object	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
runTime	string (google-datetime)	For batch transfer runs, specifies the date and time of the data should be ingested.
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, so schedule_time doesn't always match this.
scheduleTime	string (google-datetime)	Minimum time after which a transfer run can be started.
startTime	string (google-datetime)	Output only. Time when transfer run was started. Parameter ignored by server for input requests.
state	string	Data transfer run state. Ignored for input requests.
updateTime	string (google-datetime)	Output only. Last time the data transfer run state was updated.
userId	string (int64)	Deprecated. Unique ID of the user on whose behalf transfer is done.

projects_transfer_configs_runs_list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the transfer run. Transfer run names have the form projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.
dataSourceId	string	Output only. Data source id.
destinationDatasetId	string	Output only. The BigQuery target dataset id.
emailPreferences	object	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. (id: EmailPreferences)
endTime	string (google-datetime)	Output only. Time when transfer run ended. Parameter ignored by server for input requests.
errorStatus	object	Status of the transfer run. (id: Status)
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/{project_id}/topics/{topic_id}
params	object	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
runTime	string (google-datetime)	For batch transfer runs, specifies the date and time of the data should be ingested.
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, so schedule_time doesn't always match this.
scheduleTime	string (google-datetime)	Minimum time after which a transfer run can be started.
startTime	string (google-datetime)	Output only. Time when transfer run was started. Parameter ignored by server for input requests.
state	string	Data transfer run state. Ignored for input requests.
updateTime	string (google-datetime)	Output only. Last time the data transfer run state was updated.
userId	string (int64)	Deprecated. Unique ID of the user on whose behalf transfer is done.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_transfer_configs_runs_get	select	projectsId, locationsId, transferConfigsId, runsId		Returns information about the particular transfer run.
projects_transfer_configs_runs_get	select	projectsId, transferConfigsId, runsId		Returns information about the particular transfer run.
projects_locations_transfer_configs_runs_list	select	projectsId, locationsId, transferConfigsId	states, pageToken, pageSize, runAttempt	Returns information about running and completed transfer runs.
projects_transfer_configs_runs_list	select	projectsId, transferConfigsId	states, pageToken, pageSize, runAttempt	Returns information about running and completed transfer runs.
projects_locations_transfer_configs_runs_delete	delete	projectsId, locationsId, transferConfigsId, runsId		Deletes the specified transfer run.
projects_transfer_configs_runs_delete	delete	projectsId, transferConfigsId, runsId		Deletes the specified transfer run.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
runsId	string
transferConfigsId	string
pageSize	integer (int32)
pageToken	string
runAttempt	string
states	string

SELECT examples

projects_locations_transfer_configs_runs_get

Returns information about the particular transfer run.

SELECT
name,
dataSourceId,
destinationDatasetId,
emailPreferences,
endTime,
errorStatus,
notificationPubsubTopic,
params,
runTime,
schedule,
scheduleTime,
startTime,
state,
updateTime,
userId
FROM google.bigquerydatatransfer.runs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND transferConfigsId = '{{ transferConfigsId }}' -- required
AND runsId = '{{ runsId }}' -- required;

projects_transfer_configs_runs_get

Returns information about the particular transfer run.

SELECT
name,
dataSourceId,
destinationDatasetId,
emailPreferences,
endTime,
errorStatus,
notificationPubsubTopic,
params,
runTime,
schedule,
scheduleTime,
startTime,
state,
updateTime,
userId
FROM google.bigquerydatatransfer.runs
WHERE projectsId = '{{ projectsId }}' -- required
AND transferConfigsId = '{{ transferConfigsId }}' -- required
AND runsId = '{{ runsId }}' -- required;

projects_locations_transfer_configs_runs_list

Returns information about running and completed transfer runs.

SELECT
name,
dataSourceId,
destinationDatasetId,
emailPreferences,
endTime,
errorStatus,
notificationPubsubTopic,
params,
runTime,
schedule,
scheduleTime,
startTime,
state,
updateTime,
userId
FROM google.bigquerydatatransfer.runs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND transferConfigsId = '{{ transferConfigsId }}' -- required
AND states = '{{ states }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND runAttempt = '{{ runAttempt }}';

projects_transfer_configs_runs_list

Returns information about running and completed transfer runs.

SELECT
name,
dataSourceId,
destinationDatasetId,
emailPreferences,
endTime,
errorStatus,
notificationPubsubTopic,
params,
runTime,
schedule,
scheduleTime,
startTime,
state,
updateTime,
userId
FROM google.bigquerydatatransfer.runs
WHERE projectsId = '{{ projectsId }}' -- required
AND transferConfigsId = '{{ transferConfigsId }}' -- required
AND states = '{{ states }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND runAttempt = '{{ runAttempt }}';

DELETE examples

projects_locations_transfer_configs_runs_delete

Deletes the specified transfer run.

DELETE FROM google.bigquerydatatransfer.runs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND transferConfigsId = '{{ transferConfigsId }}' --required
AND runsId = '{{ runsId }}' --required;

projects_transfer_configs_runs_delete

Deletes the specified transfer run.

DELETE FROM google.bigquerydatatransfer.runs
WHERE projectsId = '{{ projectsId }}' --required
AND transferConfigsId = '{{ transferConfigsId }}' --required
AND runsId = '{{ runsId }}' --required;