Class: Google::Apis::BigquerydatatransferV1::TransferConfig
- Inherits:
-
Object
- Object
- Google::Apis::BigquerydatatransferV1::TransferConfig
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/bigquerydatatransfer_v1/classes.rb,
generated/google/apis/bigquerydatatransfer_v1/representations.rb,
generated/google/apis/bigquerydatatransfer_v1/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#data_refresh_window_days ⇒ Fixnum
The number of days to look back to automatically refresh the data.
-
#data_source_id ⇒ String
Data source id.
-
#dataset_region ⇒ String
Output only.
-
#destination_dataset_id ⇒ String
The BigQuery target dataset id.
-
#disabled ⇒ Boolean
(also: #disabled?)
Is this config disabled.
-
#display_name ⇒ String
User specified display name for the data transfer.
-
#email_preferences ⇒ Google::Apis::BigquerydatatransferV1::EmailPreferences
Represents preferences for sending email notifications for transfer run events.
-
#name ⇒ String
The resource name of the transfer config.
-
#next_run_time ⇒ String
Output only.
-
#notification_pubsub_topic ⇒ String
Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
-
#params ⇒ Hash<String,Object>
Data transfer specific parameters.
-
#schedule ⇒ String
Data transfer schedule.
-
#schedule_options ⇒ Google::Apis::BigquerydatatransferV1::ScheduleOptions
Options customizing the data transfer schedule.
-
#state ⇒ String
Output only.
-
#update_time ⇒ String
Output only.
-
#user_id ⇒ Fixnum
Deprecated.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TransferConfig
constructor
A new instance of TransferConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ TransferConfig
Returns a new instance of TransferConfig.
868 869 870 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 868 def initialize(**args) update!(**args) end |
Instance Attribute Details
#data_refresh_window_days ⇒ Fixnum
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.
Corresponds to the JSON property dataRefreshWindowDays
769 770 771 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 769 def data_refresh_window_days @data_refresh_window_days end |
#data_source_id ⇒ String
Data source id. Cannot be changed once data transfer is created.
Corresponds to the JSON property dataSourceId
774 775 776 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 774 def data_source_id @data_source_id end |
#dataset_region ⇒ String
Output only. Region in which BigQuery dataset is located.
Corresponds to the JSON property datasetRegion
779 780 781 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 779 def dataset_region @dataset_region end |
#destination_dataset_id ⇒ String
The BigQuery target dataset id.
Corresponds to the JSON property destinationDatasetId
784 785 786 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 784 def destination_dataset_id @destination_dataset_id end |
#disabled ⇒ Boolean Also known as: disabled?
Is this config disabled. When set to true, no runs are scheduled
for a given transfer.
Corresponds to the JSON property disabled
790 791 792 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 790 def disabled @disabled end |
#display_name ⇒ String
User specified display name for the data transfer.
Corresponds to the JSON property displayName
796 797 798 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 796 def display_name @display_name end |
#email_preferences ⇒ Google::Apis::BigquerydatatransferV1::EmailPreferences
Represents preferences for sending email notifications for transfer run
events.
Corresponds to the JSON property emailPreferences
802 803 804 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 802 def email_preferences @email_preferences end |
#name ⇒ String
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.
Corresponds to the JSON property
name`
813 814 815 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 813 def name @name end |
#next_run_time ⇒ String
Output only. Next time when data transfer will run.
Corresponds to the JSON property nextRunTime
818 819 820 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 818 def next_run_time @next_run_time end |
#notification_pubsub_topic ⇒ String
Pub/Sub topic where notifications will be sent after transfer runs
associated with this transfer config finish.
Corresponds to the JSON property notificationPubsubTopic
824 825 826 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 824 def notification_pubsub_topic @notification_pubsub_topic end |
#params ⇒ Hash<String,Object>
Data transfer specific parameters.
Corresponds to the JSON property params
829 830 831 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 829 def params @params end |
#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 granularity should be at least 8 hours, or less frequent.
Corresponds to the JSON property schedule
846 847 848 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 846 def schedule @schedule end |
#schedule_options ⇒ Google::Apis::BigquerydatatransferV1::ScheduleOptions
Options customizing the data transfer schedule.
Corresponds to the JSON property scheduleOptions
851 852 853 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 851 def @schedule_options end |
#state ⇒ String
Output only. State of the most recently updated transfer run.
Corresponds to the JSON property state
856 857 858 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 856 def state @state end |
#update_time ⇒ String
Output only. Data transfer modification time. Ignored by server on input.
Corresponds to the JSON property updateTime
861 862 863 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 861 def update_time @update_time end |
#user_id ⇒ Fixnum
Deprecated. Unique ID of the user on whose behalf transfer is done.
Corresponds to the JSON property userId
866 867 868 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 866 def user_id @user_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 873 def update!(**args) @data_refresh_window_days = args[:data_refresh_window_days] if args.key?(:data_refresh_window_days) @data_source_id = args[:data_source_id] if args.key?(:data_source_id) @dataset_region = args[:dataset_region] if args.key?(:dataset_region) @destination_dataset_id = args[:destination_dataset_id] if args.key?(:destination_dataset_id) @disabled = args[:disabled] if args.key?(:disabled) @display_name = args[:display_name] if args.key?(:display_name) @email_preferences = args[:email_preferences] if args.key?(:email_preferences) @name = args[:name] if args.key?(:name) @next_run_time = args[:next_run_time] if args.key?(:next_run_time) @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic) @params = args[:params] if args.key?(:params) @schedule = args[:schedule] if args.key?(:schedule) @schedule_options = args[:schedule_options] if args.key?(:schedule_options) @state = args[:state] if args.key?(:state) @update_time = args[:update_time] if args.key?(:update_time) @user_id = args[:user_id] if args.key?(:user_id) end |