Class: Google::Apis::BigquerydatatransferV1::TransferRun

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

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) ⇒ TransferRun

Returns a new instance of TransferRun



818
819
820
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 818

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#data_source_id ⇒ String

Data source id. Output only. Corresponds to the JSON property dataSourceId

Returns:

  • (String) 


735
736
737
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 735

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". Output only. Corresponds to the JSON property datasetRegion

Returns:

  • (String) 


742
743
744
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 742

def dataset_region
  @dataset_region
end

#destination_dataset_id ⇒ String

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

Returns:

  • (String) 


747
748
749
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 747

def destination_dataset_id
  @destination_dataset_id
end

#end_time ⇒ String

Time when transfer run ended. Parameter ignored by server for input requests. Output only. Corresponds to the JSON property endTime

Returns:

  • (String) 


754
755
756
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 754

def end_time
  @end_time
end

#name ⇒ String

The resource name of the transfer run. Transfer run names have the form projects/project_id/locations/location/transferConfigs/config_id/runs/ run_id`. The name is ignored when creating a transfer run. Corresponds to the JSON propertyname`

Returns:

  • (String) 


763
764
765
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 763

def name
  @name
end

#params ⇒ Hash<String,Object>

Data transfer specific parameters. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


768
769
770
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 768

def params
  @params
end

#run_time ⇒ String

For batch transfer runs, specifies the date and time that data should be ingested. Corresponds to the JSON property runTime

Returns:

  • (String) 


774
775
776
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 774

def run_time
  @run_time
end

#schedule ⇒ String

Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are directly created, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so schedule_time doesn't always matches this. Output only. Corresponds to the JSON property schedule

Returns:

  • (String) 


784
785
786
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 784

def schedule
  @schedule
end

#schedule_time ⇒ String

Minimum time after which a transfer run can be started. Corresponds to the JSON property scheduleTime

Returns:

  • (String) 


789
790
791
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 789

def schedule_time
  @schedule_time
end

#start_time ⇒ String

Time when transfer run was started. Parameter ignored by server for input requests. Output only. Corresponds to the JSON property startTime

Returns:

  • (String) 


796
797
798
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 796

def start_time
  @start_time
end

#state ⇒ String

Data transfer run state. Ignored for input requests. Output only. Corresponds to the JSON property state

Returns:

  • (String) 


802
803
804
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 802

def state
  @state
end

#update_time ⇒ String

Last time the data transfer run state was updated. Output only. Corresponds to the JSON property updateTime

Returns:

  • (String) 


808
809
810
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 808

def update_time
  @update_time
end

#user_id ⇒ Fixnum

Unique ID 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. Output only. Corresponds to the JSON property userId

Returns:

  • (Fixnum) 


816
817
818
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 816

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 823

def update!(**args)
  @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)
  @end_time = args[:end_time] if args.key?(:end_time)
  @name = args[:name] if args.key?(:name)
  @params = args[:params] if args.key?(:params)
  @run_time = args[:run_time] if args.key?(:run_time)
  @schedule = args[:schedule] if args.key?(:schedule)
  @schedule_time = args[:schedule_time] if args.key?(:schedule_time)
  @start_time = args[:start_time] if args.key?(:start_time)
  @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