bigquerydatatransfer  v1
Properties | List of all members
Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig Class Reference

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. More...

Inheritance diagram for Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig:
Google::Apis::Requests::IDirectResponseSchema

Properties

virtual System.Nullable< int > DataRefreshWindowDays [get, set]
 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. More...
 
virtual string DataSourceId [get, set]
 Data source id. Cannot be changed once data transfer is created. More...
 
virtual string DatasetRegion [get, set]
 Output only. Region in which BigQuery dataset is located. More...
 
virtual string DestinationDatasetId [get, set]
 The BigQuery target dataset id. More...
 
virtual System.Nullable< bool > Disabled [get, set]
 Is this config disabled. When set to true, no runs are scheduled for a given transfer. More...
 
virtual string DisplayName [get, set]
 User specified display name for the data transfer. More...
 
virtual EmailPreferences EmailPreferences [get, set]
 Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. More...
 
virtual string Name [get, set]
 The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. More...
 
virtual object NextRunTime [get, set]
 Output only. Next time when data transfer will run. More...
 
virtual string NotificationPubsubTopic [get, set]
 Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. More...
 
virtual System.Collections.Generic.IDictionary< string, object > Params__ [get, set]
 Data transfer specific parameters. More...
 
virtual string Schedule [get, set]
 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 granularity should be at least 8 hours, or less frequent. More...
 
virtual ScheduleOptions ScheduleOptions [get, set]
 Options customizing the data transfer schedule. More...
 
virtual string State [get, set]
 Output only. State of the most recently updated transfer run. More...
 
virtual object UpdateTime [get, set]
 Output only. Data transfer modification time. Ignored by server on input. More...
 
virtual System.Nullable< long > UserId [get, set]
 Deprecated. Unique ID of the user on whose behalf transfer is done. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

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.

Property Documentation

◆ DataRefreshWindowDays

virtual System.Nullable<int> Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.DataRefreshWindowDays
getset

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.

◆ DatasetRegion

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.DatasetRegion
getset

Output only. Region in which BigQuery dataset is located.

◆ DataSourceId

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.DataSourceId
getset

Data source id. Cannot be changed once data transfer is created.

◆ DestinationDatasetId

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.DestinationDatasetId
getset

The BigQuery target dataset id.

◆ Disabled

virtual System.Nullable<bool> Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.Disabled
getset

Is this config disabled. When set to true, no runs are scheduled for a given transfer.

◆ DisplayName

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.DisplayName
getset

User specified display name for the data transfer.

◆ EmailPreferences

virtual EmailPreferences Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.EmailPreferences
getset

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

◆ ETag

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.ETag
getset

The ETag of the item.

◆ Name

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.Name
getset

The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.

◆ NextRunTime

virtual object Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.NextRunTime
getset

Output only. Next time when data transfer will run.

◆ NotificationPubsubTopic

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.NotificationPubsubTopic
getset

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

◆ Params__

virtual System.Collections.Generic.IDictionary<string,object> Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.Params__
getset

Data transfer specific parameters.

◆ Schedule

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.Schedule
getset

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 granularity should be at least 8 hours, or less frequent.

◆ ScheduleOptions

virtual ScheduleOptions Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.ScheduleOptions
getset

Options customizing the data transfer schedule.

◆ State

virtual string Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.State
getset

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

◆ UpdateTime

virtual object Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.UpdateTime
getset

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

◆ UserId

virtual System.Nullable<long> Google.Apis.BigQueryDataTransfer.v1.Data.TransferConfig.UserId
getset

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


The documentation for this class was generated from the following file: