TransferRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a data transfer run.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes
Name | Description |
name |
str
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. |
schedule_time |
google.protobuf.timestamp_pb2.Timestamp
Minimum time after which a transfer run can be started. |
run_time |
google.protobuf.timestamp_pb2.Timestamp
For batch transfer runs, specifies the date and time of the data should be ingested. |
error_status |
google.rpc.status_pb2.Status
Status of the transfer run. |
start_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when transfer run was started. Parameter ignored by server for input requests. |
end_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when transfer run ended. Parameter ignored by server for input requests. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Last time the data transfer run state was updated. |
params |
google.protobuf.struct_pb2.Struct
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 |
destination_dataset_id |
str
Output only. The BigQuery target dataset id. This field is a member of `oneof`_ ``destination``. |
data_source_id |
str
Output only. Data source id. |
state |
google.cloud.bigquery_datatransfer_v1.types.TransferState
Data transfer run state. Ignored for input requests. |
user_id |
int
Deprecated. Unique ID of the user on whose behalf transfer is done. |
schedule |
str
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. |
notification_pubsub_topic |
str
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}`` |
email_preferences |
google.cloud.bigquery_datatransfer_v1.types.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. |