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



798
799
800
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 798

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

Instance Attribute Details

#data_source_id ⇒ String

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

Returns:

  • (String) 


723
724
725
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 723

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

Returns:

  • (String) 


728
729
730
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 728

def dataset_region
  @dataset_region
end

#destination_dataset_id ⇒ String

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

Returns:

  • (String) 


733
734
735
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 733

def destination_dataset_id
  @destination_dataset_id
end

#end_time ⇒ String

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

Returns:

  • (String) 


739
740
741
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 739

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) 


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

def name
  @name
end

#params ⇒ Hash<String,Object>

Data transfer specific parameters. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


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

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) 


759
760
761
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 759

def run_time
  @run_time
end

#schedule ⇒ String

Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, 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) 


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

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) 


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

def schedule_time
  @schedule_time
end

#start_time ⇒ String

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

Returns:

  • (String) 


779
780
781
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 779

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


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

def state
  @state
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

def update_time
  @update_time
end

#user_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 803

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