runs
Overview
| Name | runs |
| Type | Resource |
| Id | google.bigquerydatatransfer.runs |
Fields
| Name | Datatype | Description |
|---|---|---|
name | string | 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 | Represents preferences for sending email notifications for transfer run events. |
endTime | string | Output only. Time when transfer run ended. Parameter ignored by server for input requests. |
errorStatus | object | The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. |
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}/topics/{topic} |
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 | 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 | Minimum time after which a transfer run can be started. |
startTime | string | 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 | Output only. Last time the data transfer run state was updated. |
userId | string | Deprecated. Unique ID of the user on whose behalf transfer is done. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
projects_locations_transfer_configs_runs_get | SELECT | locationsId, projectsId, runsId, transferConfigsId | Returns information about the particular transfer run. |
projects_locations_transfer_configs_runs_list | SELECT | locationsId, projectsId, transferConfigsId | Returns information about running and completed transfer runs. |
projects_transfer_configs_runs_get | SELECT | projectsId, runsId, transferConfigsId | Returns information about the particular transfer run. |
projects_transfer_configs_runs_list | SELECT | projectsId, transferConfigsId | Returns information about running and completed transfer runs. |
projects_locations_transfer_configs_runs_delete | DELETE | locationsId, projectsId, runsId, transferConfigsId | Deletes the specified transfer run. |
projects_transfer_configs_runs_delete | DELETE | projectsId, runsId, transferConfigsId | Deletes the specified transfer run. |
_projects_locations_transfer_configs_runs_list | EXEC | locationsId, projectsId, transferConfigsId | Returns information about running and completed transfer runs. |
_projects_transfer_configs_runs_list | EXEC | projectsId, transferConfigsId | Returns information about running and completed transfer runs. |