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. Next id: 23

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



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

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) 


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

def data_source_id
  @data_source_id
end

#destination_dataset_id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


744
745
746
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 744

def name
  @name
end

#params ⇒ Hash<String,Object>

Data transfer specific parameters. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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. May be negative. Corresponds to the JSON property userId

Returns:

  • (Fixnum) 


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

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



800
801
802
803
804
805
806
807
808
809
810
811
812
813
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 800

def update!(**args)
  @data_source_id = args[:data_source_id] if args.key?(:data_source_id)
  @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