Reference documentation and code samples for the BigQuery Data Transfer V1 Client class TransferRun.
Represents a data transfer run.
Generated from protobuf message google.cloud.bigquery.datatransfer.v1.TransferRun
Namespace
Google \ Cloud \ BigQuery \ DataTransfer \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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.
↳ schedule_time
↳ run_time
Google\Protobuf\Timestamp
For batch transfer runs, specifies the date and time of the data should be ingested.
↳ error_status
↳ start_time
Google\Protobuf\Timestamp
Output only. Time when transfer run was started. Parameter ignored by server for input requests.
↳ end_time
Google\Protobuf\Timestamp
Output only. Time when transfer run ended. Parameter ignored by server for input requests.
↳ update_time
↳ params
Google\Protobuf\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
string
Output only. The BigQuery target dataset id.
↳ data_source_id
string
Output only. Data source id.
↳ state
int
Data transfer run state. Ignored for input requests.
↳ user_id
int|string
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, so schedule_time
doesn't always match this.
↳ notification_pubsub_topic
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}
↳ email_preferences
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.
getName
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.
string
setName
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.
var
string
$this
getScheduleTime
Minimum time after which a transfer run can be started.
hasScheduleTime
clearScheduleTime
setScheduleTime
Minimum time after which a transfer run can be started.
$this
getRunTime
For batch transfer runs, specifies the date and time of the data should be ingested.
hasRunTime
clearRunTime
setRunTime
For batch transfer runs, specifies the date and time of the data should be ingested.
$this
getErrorStatus
Status of the transfer run.
hasErrorStatus
clearErrorStatus
setErrorStatus
Status of the transfer run.
$this
getStartTime
Output only. Time when transfer run was started.
Parameter ignored by server for input requests.
hasStartTime
clearStartTime
setStartTime
Output only. Time when transfer run was started.
Parameter ignored by server for input requests.
$this
getEndTime
Output only. Time when transfer run ended.
Parameter ignored by server for input requests.
hasEndTime
clearEndTime
setEndTime
Output only. Time when transfer run ended.
Parameter ignored by server for input requests.
$this
getUpdateTime
Output only. Last time the data transfer run state was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last time the data transfer run state was updated.
$this
getParams
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
hasParams
clearParams
setParams
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
$this
getDestinationDatasetId
Output only. The BigQuery target dataset id.
string
hasDestinationDatasetId
setDestinationDatasetId
Output only. The BigQuery target dataset id.
var
string
$this
getDataSourceId
Output only. Data source id.
string
setDataSourceId
Output only. Data source id.
var
string
$this
getState
Data transfer run state. Ignored for input requests.
int
setState
Data transfer run state. Ignored for input requests.
var
int
$this
getUserId
Deprecated. Unique ID of the user on whose behalf transfer is done.
int|string
setUserId
Deprecated. Unique ID of the user on whose behalf transfer is done.
var
int|string
$this
getSchedule
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.
string
setSchedule
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.
var
string
$this
getNotificationPubsubTopic
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}
string
setNotificationPubsubTopic
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}
var
string
$this
getEmailPreferences
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.
hasEmailPreferences
clearEmailPreferences
setEmailPreferences
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.
$this
getDestination
string
