BigQuery Data Transfer V1 Client - Class TransferConfig (2.1.0)

Reference documentation and code samples for the BigQuery Data Transfer V1 Client class TransferConfig.

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destination_dataset_id specifies where data should be stored.

When a new transfer configuration is created, the specified destination_dataset_id is created when needed and shared with the appropriate data source service account.

Generated from protobuf message google.cloud.bigquery.datatransfer.v1.TransferConfig

Namespace

Google \ Cloud \ BigQuery \ DataTransfer \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
↳ destination_dataset_id string

The BigQuery target dataset id.
↳ display_name string

User specified display name for the data transfer.
↳ data_source_id string

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
↳ params Google\Protobuf\Struct

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
↳ schedule string

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
↳ schedule_options Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptions

Options customizing the data transfer schedule.
↳ schedule_options_v2 Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptionsV2

Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
↳ data_refresh_window_days int

The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
↳ disabled bool

Is this config disabled. When set to true, no runs will be scheduled for this transfer config.
↳ update_time Google\Protobuf\Timestamp

Output only. Data transfer modification time. Ignored by server on input.
↳ next_run_time Google\Protobuf\Timestamp

Output only. Next time when data transfer will run.
↳ state int

Output only. State of the most recently updated transfer run.
↳ user_id int|string

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

Output only. Region in which BigQuery dataset is located.
↳ notification_pubsub_topic string

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}
↳ email_preferences Google\Cloud\BigQuery\DataTransfer\V1\EmailPreferences

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
↳ owner_info Google\Cloud\BigQuery\DataTransfer\V1\UserInfo

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.
↳ encryption_configuration Google\Cloud\BigQuery\DataTransfer\V1\EncryptionConfiguration

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
↳ error Google\Rpc\Status

Output only. Error code with detailed information about reason of the latest config failure.

getName

Identifier. The resource name of the transfer config.

Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

Returns
Type Description
string

setName

Identifier. The resource name of the transfer config.

Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationDatasetId

The BigQuery target dataset id.

Returns
Type Description
string

hasDestinationDatasetId

setDestinationDatasetId

The BigQuery target dataset id.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

User specified display name for the data transfer.

Returns
Type Description
string

setDisplayName

User specified display name for the data transfer.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataSourceId

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

Returns
Type Description
string

setDataSourceId

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

Parameter
Name Description
var string
Returns
Type Description
$this

getParams

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
Type Description
Google\Protobuf\Struct|null

hasParams

clearParams

setParams

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
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this

getSchedule

Data transfer schedule.

If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

Returns
Type Description
string

setSchedule

Data transfer schedule.

If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

Parameter
Name Description
var string
Returns
Type Description
$this

getScheduleOptions

Options customizing the data transfer schedule.

Returns
Type Description
Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptions|null

hasScheduleOptions

clearScheduleOptions

setScheduleOptions

Options customizing the data transfer schedule.

Parameter
Name Description
var Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptions
Returns
Type Description
$this

getScheduleOptionsV2

Options customizing different types of data transfer schedule.

This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

Returns
Type Description
Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptionsV2|null

hasScheduleOptionsV2

clearScheduleOptionsV2

setScheduleOptionsV2

Options customizing different types of data transfer schedule.

This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

Parameter
Name Description
var Google\Cloud\BigQuery\DataTransfer\V1\ScheduleOptionsV2
Returns
Type Description
$this

getDataRefreshWindowDays

The number of days to look back to automatically refresh the data.

For example, if data_refresh_window_days = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.

Returns
Type Description
int

setDataRefreshWindowDays

The number of days to look back to automatically refresh the data.

For example, if data_refresh_window_days = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.

Parameter
Name Description
var int
Returns
Type Description
$this

getDisabled

Is this config disabled. When set to true, no runs will be scheduled for this transfer config.

Returns
Type Description
bool

setDisabled

Is this config disabled. When set to true, no runs will be scheduled for this transfer config.

Parameter
Name Description
var bool
Returns
Type Description
$this

getUpdateTime

Output only. Data transfer modification time. Ignored by server on input.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Data transfer modification time. Ignored by server on input.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getNextRunTime

Output only. Next time when data transfer will run.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasNextRunTime

clearNextRunTime

setNextRunTime

Output only. Next time when data transfer will run.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. State of the most recently updated transfer run.

Returns
Type Description
int

setState

Output only. State of the most recently updated transfer run.

Parameter
Name Description
var int
Returns
Type Description
$this

getUserId

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

Returns
Type Description
int|string

setUserId

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDatasetRegion

Output only. Region in which BigQuery dataset is located.

Returns
Type Description
string

setDatasetRegion

Output only. Region in which BigQuery dataset is located.

Parameter
Name Description
var string
Returns
Type Description
$this

getNotificationPubsubTopic

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

Returns
Type Description
string

setNotificationPubsubTopic

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getEmailPreferences

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

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

hasEmailPreferences

clearEmailPreferences

setEmailPreferences

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

Parameter
Name Description
var Google\Cloud\BigQuery\DataTransfer\V1\EmailPreferences
Returns
Type Description
$this

getOwnerInfo

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

Returns
Type Description
Google\Cloud\BigQuery\DataTransfer\V1\UserInfo|null

hasOwnerInfo

clearOwnerInfo

setOwnerInfo

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

Parameter
Name Description
var Google\Cloud\BigQuery\DataTransfer\V1\UserInfo
Returns
Type Description
$this

getEncryptionConfiguration

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

Returns
Type Description
Google\Cloud\BigQuery\DataTransfer\V1\EncryptionConfiguration|null

hasEncryptionConfiguration

clearEncryptionConfiguration

setEncryptionConfiguration

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

Parameter
Name Description
var Google\Cloud\BigQuery\DataTransfer\V1\EncryptionConfiguration
Returns
Type Description
$this

getError

Output only. Error code with detailed information about reason of the latest config failure.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

Output only. Error code with detailed information about reason of the latest config failure.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getDestination

Returns
Type Description
string