BigQuery Data Transfer V1 Client - Class TransferRun (1.5.2)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getScheduleTime

Minimum time after which a transfer run can be started.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasScheduleTime

clearScheduleTime

setScheduleTime

Minimum time after which a transfer run can be started.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getRunTime

For batch transfer runs, specifies the date and time of the data should be ingested.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasRunTime

clearRunTime

setRunTime

For batch transfer runs, specifies the date and time of the data should be ingested.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getErrorStatus

Status of the transfer run.

Returns
TypeDescription
Google\Rpc\Status|null

hasErrorStatus

clearErrorStatus

setErrorStatus

Status of the transfer run.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getStartTime

Output only. Time when transfer run was started.

Parameter ignored by server for input requests.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. Time when transfer run was started.

Parameter ignored by server for input requests.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

Output only. Time when transfer run ended.

Parameter ignored by server for input requests.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. Time when transfer run ended.

Parameter ignored by server for input requests.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Last time the data transfer run state was updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last time the data transfer run state was updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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

Returns
TypeDescription
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

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$this

getDestinationDatasetId

Output only. The BigQuery target dataset id.

Returns
TypeDescription
string

hasDestinationDatasetId

setDestinationDatasetId

Output only. The BigQuery target dataset id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataSourceId

Output only. Data source id.

Returns
TypeDescription
string

setDataSourceId

Output only. Data source id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Data transfer run state. Ignored for input requests.

Returns
TypeDescription
int

setState

Data transfer run state. Ignored for input requests.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getUserId

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

Returns
TypeDescription
int|string

setUserId

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$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}

Returns
TypeDescription
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}

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var Google\Cloud\BigQuery\DataTransfer\V1\EmailPreferences
Returns
TypeDescription
$this

getDestination

Returns
TypeDescription
string