Class: Google::Apis::BigquerydatatransferV1::TransferConfig

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TransferConfig

Returns a new instance of TransferConfig



721
722
723
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 721

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

Returns:

  • (Fixnum) 


632
633
634
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 632

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

Returns:

  • (String) 


637
638
639
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 637

def data_source_id
  @data_source_id
end

#dataset_region ⇒ String

Region in which BigQuery dataset is located. Currently possible values are: "US" and "EU". Corresponds to the JSON property datasetRegion

Returns:

  • (String) 


644
645
646
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 644

def dataset_region
  @dataset_region
end

#destination_dataset_id ⇒ String

The BigQuery target dataset id. Corresponds to the JSON property destinationDatasetId

Returns:

  • (String) 


649
650
651
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 649

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

Returns:

  • (Boolean) 


655
656
657
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 655

def disabled
  @disabled
end

#display_name ⇒ String

User specified display name for the data transfer. Corresponds to the JSON property displayName

Returns:

  • (String) 


661
662
663
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 661

def display_name
  @display_name
end

#name ⇒ String

The resource name of the transfer run. Transfer run names have the form projects/project_id/transferConfigs/config_id`. Whereconfig_idis usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer run. Corresponds to the JSON propertyname`

Returns:

  • (String) 


670
671
672
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 670

def name
  @name
end

#next_run_time ⇒ String

Next time when data transfer will run. Output only. Applicable only for batch data transfers. Corresponds to the JSON property nextRunTime

Returns:

  • (String) 


677
678
679
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 677

def next_run_time
  @next_run_time
end

#params ⇒ Hash<String,Object>

Data transfer specific parameters. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


682
683
684
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 682

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

Returns:

  • (String) 


699
700
701
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 699

def schedule
  @schedule
end

#status ⇒ String

Status of the most recently updated transfer run. Corresponds to the JSON property status

Returns:

  • (String) 


705
706
707
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 705

def status
  @status
end

#update_time ⇒ String

Data transfer modification time. Ignored by server on input. Corresponds to the JSON property updateTime

Returns:

  • (String) 


711
712
713
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 711

def update_time
  @update_time
end

#user_id ⇒ Fixnum

GaiaID of the user on whose behalf transfer is done. Applicable only to data sources that do not support service accounts. When set to 0, the data source service account credentials are used. Corresponds to the JSON property userId

Returns:

  • (Fixnum) 


719
720
721
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 719

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 726

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)
  @name = args[:name] if args.key?(:name)
  @next_run_time = args[:next_run_time] if args.key?(:next_run_time)
  @params = args[:params] if args.key?(:params)
  @schedule = args[:schedule] if args.key?(:schedule)
  @status = args[:status] if args.key?(:status)
  @update_time = args[:update_time] if args.key?(:update_time)
  @user_id = args[:user_id] if args.key?(:user_id)
end