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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/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.
↳ 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 are scheduled for a given transfer.
↳ 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}/topics/{topic}
↳ 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.
getName
The resource name of the transfer config.
Transfer config names have the form projects/{project_id}/locations/{region}/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.
Generated from protobuf field string name = 1;
string
setName
The resource name of the transfer config.
Transfer config names have the form projects/{project_id}/locations/{region}/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.
Generated from protobuf field string name = 1;
var
string
$this
getDestinationDatasetId
The BigQuery target dataset id.
Generated from protobuf field string destination_dataset_id = 2;
string
hasDestinationDatasetId
setDestinationDatasetId
The BigQuery target dataset id.
Generated from protobuf field string destination_dataset_id = 2;
var
string
$this
getDisplayName
User specified display name for the data transfer.
Generated from protobuf field string display_name = 3;
string
setDisplayName
User specified display name for the data transfer.
Generated from protobuf field string display_name = 3;
var
string
$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
Generated from protobuf field string data_source_id = 5;
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
Generated from protobuf field string data_source_id = 5;
var
string
$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
Generated from protobuf field .google.protobuf.Struct params = 9;
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
Generated from protobuf field .google.protobuf.Struct params = 9;
var
Google\Protobuf\Struct
$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.
Generated from protobuf field string schedule = 7;
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.
Generated from protobuf field string schedule = 7;
var
string
$this
getScheduleOptions
Options customizing the data transfer schedule.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
hasScheduleOptions
clearScheduleOptions
setScheduleOptions
Options customizing the data transfer schedule.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.ScheduleOptions schedule_options = 24;
$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.
Generated from protobuf field int32 data_refresh_window_days = 12;
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.
Generated from protobuf field int32 data_refresh_window_days = 12;
var
int
$this
getDisabled
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
Generated from protobuf field bool disabled = 13;
bool
setDisabled
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
Generated from protobuf field bool disabled = 13;
var
bool
$this
getUpdateTime
Output only. Data transfer modification time. Ignored by server on input.
Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Data transfer modification time. Ignored by server on input.
Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getNextRunTime
Output only. Next time when data transfer will run.
Generated from protobuf field .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasNextRunTime
clearNextRunTime
setNextRunTime
Output only. Next time when data transfer will run.
Generated from protobuf field .google.protobuf.Timestamp next_run_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getState
Output only. State of the most recently updated transfer run.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
setState
Output only. State of the most recently updated transfer run.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
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
getDatasetRegion
Output only. Region in which BigQuery dataset is located.
Generated from protobuf field string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setDatasetRegion
Output only. Region in which BigQuery dataset is located.
Generated from protobuf field string dataset_region = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$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}/topics/{topic}
Generated from protobuf field string notification_pubsub_topic = 15;
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}/topics/{topic}
Generated from protobuf field string notification_pubsub_topic = 15;
var
string
$this
getEmailPreferences
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;
hasEmailPreferences
clearEmailPreferences
setEmailPreferences
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 18;
$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.
Generated from protobuf field optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field optional .google.cloud.bigquery.datatransfer.v1.UserInfo owner_info = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
getDestination
string
