BigQuery Data Transfer V1 Client - Class TransferRun (1.3.8)

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.

Parameters
Name	Description
`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`	`Google\Rpc\Status` Status of the transfer run.
`↳ 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;

Returns
Type	Description
`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;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getScheduleTime

Minimum time after which a transfer run can be started.

Generated from protobuf field .google.protobuf.Timestamp schedule_time = 3;

Returns
Type	Description
`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;

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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;

Returns
Type	Description
`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;

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getErrorStatus

Status of the transfer run.

Generated from protobuf field .google.rpc.Status error_status = 21;

Returns
Type	Description
`Google\Rpc\Status\|null`

hasErrorStatus

clearErrorStatus

setErrorStatus

Status of the transfer run.

Generated from protobuf field .google.rpc.Status error_status = 21;

Parameter
Name	Description
`var`	`Google\Rpc\Status`

Returns
Type	Description
`$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];

Returns
Type	Description
`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];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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];

Returns
Type	Description
`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];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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];

Returns
Type	Description
`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];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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];

Returns
Type	Description
`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];

Parameter
Name	Description
`var`	`Google\Protobuf\Struct`

Returns
Type	Description
`$this`

getDestinationDatasetId

Output only. The BigQuery target dataset id.

Generated from protobuf field string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`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];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDataSourceId

Output only. Data source id.

Generated from protobuf field string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setDataSourceId

Output only. Data source id.

Generated from protobuf field string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Data transfer run state. Ignored for input requests.

Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferState state = 8;

Returns
Type	Description
`int`

setState

Data transfer run state. Ignored for input requests.

Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferState state = 8;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getUserId

Deprecated. Unique ID of the user on whose behalf transfer is done.

Generated from protobuf field int64 user_id = 11;

Returns
Type	Description
`int\|string`

setUserId

Deprecated. Unique ID of the user on whose behalf transfer is done.

Generated from protobuf field int64 user_id = 11;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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];

Returns
Type	Description
`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];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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];

Returns
Type	Description
`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];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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];

Returns
Type	Description
`Google\Cloud\BigQuery\DataTransfer\V1\EmailPreferences\|null`

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];

Parameter
Name	Description
`var`	`Google\Cloud\BigQuery\DataTransfer\V1\EmailPreferences`

Returns
Type	Description
`$this`

getDestination

Returns
Type	Description
`string`