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



863
864
865
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 863

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

Instance Attribute Details

#data_source_id ⇒ String

Data source id. Corresponds to the JSON property dataSourceId

Returns:

  • (String) 


782
783
784
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 782

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) 


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

def dataset_region
  @dataset_region
end

#destination_dataset_id ⇒ String

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

Returns:

  • (String) 


794
795
796
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 794

def destination_dataset_id
  @destination_dataset_id
end

#end_time ⇒ String

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

Returns:

  • (String) 


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

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) 


810
811
812
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 810

def name
  @name
end

#params ⇒ Hash<String,Object>

Data transfer specific parameters. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


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

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) 


821
822
823
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 821

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. Corresponds to the JSON property schedule

Returns:

  • (String) 


831
832
833
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 831

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) 


836
837
838
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 836

def schedule_time
  @schedule_time
end

#start_time ⇒ String

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

Returns:

  • (String) 


843
844
845
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 843

def start_time
  @start_time
end

#status ⇒ String

Data transfer run status. Ignored for input requests. Corresponds to the JSON property status

Returns:

  • (String) 


849
850
851
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 849

def status
  @status
end

#update_time ⇒ String

Last time the data transfer run status was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


855
856
857
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 855

def update_time
  @update_time
end

#user_id ⇒ Fixnum

The user id for this transfer run. Corresponds to the JSON property userId

Returns:

  • (Fixnum) 


861
862
863
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 861

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 868

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)
  @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