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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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.
↳ schedule_time
Google\Protobuf\Timestamp
Minimum time after which a transfer run can be started.
↳ 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
Google\Protobuf\Timestamp
Output only. Last time the data transfer run state was updated.
↳ 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}/topics/{topic}
↳ email_preferences
Google\Cloud\BigQuery\DataTransfer\V1\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
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.
Generated from protobuf field string name = 1;
string
setName
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.
Generated from protobuf field string name = 1;
var
string
$this
getScheduleTime
Minimum time after which a transfer run can be started.
Generated from protobuf field .google.protobuf.Timestamp schedule_time = 3;
Google\Protobuf\Timestamp|null
hasScheduleTime
clearScheduleTime
setScheduleTime
Minimum time after which a transfer run can be started.
Generated from protobuf field .google.protobuf.Timestamp schedule_time = 3;
var
Google\Protobuf\Timestamp
$this
getRunTime
For batch transfer runs, specifies the date and time of the data should be ingested.
Generated from protobuf field .google.protobuf.Timestamp run_time = 10;
Google\Protobuf\Timestamp|null
hasRunTime
clearRunTime
setRunTime
For batch transfer runs, specifies the date and time of the data should be ingested.
Generated from protobuf field .google.protobuf.Timestamp run_time = 10;
var
Google\Protobuf\Timestamp
$this
getErrorStatus
Status of the transfer run.
Generated from protobuf field .google.rpc.Status error_status = 21;
hasErrorStatus
clearErrorStatus
setErrorStatus
Status of the transfer run.
Generated from protobuf field .google.rpc.Status error_status = 21;
$this
getStartTime
Output only. Time when transfer run was started.
Parameter ignored by server for input requests.
Generated from protobuf field .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasStartTime
clearStartTime
setStartTime
Output only. Time when transfer run was started.
Parameter ignored by server for input requests.
Generated from protobuf field .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getEndTime
Output only. Time when transfer run ended.
Parameter ignored by server for input requests.
Generated from protobuf field .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasEndTime
clearEndTime
setEndTime
Output only. Time when transfer run ended.
Parameter ignored by server for input requests.
Generated from protobuf field .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. Last time the data transfer run state was updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last time the data transfer run state was updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$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
Generated from protobuf field .google.protobuf.Struct params = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Struct|null
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
Generated from protobuf field .google.protobuf.Struct params = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Struct
$this
getDestinationDatasetId
Output only. The BigQuery target dataset id.
Generated from protobuf field string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
hasDestinationDatasetId
setDestinationDatasetId
Output only. The BigQuery target dataset id.
Generated from protobuf field string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getDataSourceId
Output only. Data source id.
Generated from protobuf field string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setDataSourceId
Output only. Data source id.
Generated from protobuf field string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getState
Data transfer run state. Ignored for input requests.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
int
setState
Data transfer run state. Ignored for input requests.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
var
int
$this
getUserId
Deprecated. Unique ID of the user on whose behalf transfer is done.
Generated from protobuf field int64 user_id = 11;
int|string
setUserId
Deprecated. Unique ID of the user on whose behalf transfer is done.
Generated from protobuf field int64 user_id = 11;
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.
Generated from protobuf field string schedule = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field string schedule = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
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}/topics/{topic}
Generated from protobuf field string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
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}/topics/{topic}
Generated from protobuf field string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
getDestination
string
