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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquerydatatransfer_v1/classes.rb,
lib/google/apis/bigquerydatatransfer_v1/representations.rb,
lib/google/apis/bigquerydatatransfer_v1/representations.rb

Overview

Represents a data transfer run.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TransferRun

Returns a new instance of TransferRun.



1053
1054
1055
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1053

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) 


963
964
965
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 963

def data_source_id
  @data_source_id
end

#destination_dataset_id ⇒ String

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

Returns:

  • (String) 


968
969
970
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 968

def destination_dataset_id
  @destination_dataset_id
end

#email_preferences ⇒ Google::Apis::BigquerydatatransferV1::EmailPreferences

Represents preferences for sending email notifications for transfer run events. Corresponds to the JSON property emailPreferences

Returns:



973
974
975
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 973

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


979
980
981
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 979

def end_time
  @end_time
end

#error_status ⇒ Google::Apis::BigquerydatatransferV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property errorStatus

Returns:



989
990
991
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 989

def error_status
  @error_status
end

#name ⇒ String

Identifier. 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) 


996
997
998
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 996

def name
  @name
end

#notification_pubsub_topic ⇒ String

Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: projects/ project_id/topics/topic_id` Corresponds to the JSON propertynotificationPubsubTopic`

Returns:

  • (String) 


1003
1004
1005
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1003

def notification_pubsub_topic
  @notification_pubsub_topic
end

#params ⇒ Hash<String,Object>

Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https:/ /cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


1011
1012
1013
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1011

def params
  @params
end

#run_time ⇒ String

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

Returns:

  • (String) 


1017
1018
1019
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1017

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

Returns:

  • (String) 


1025
1026
1027
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1025

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) 


1030
1031
1032
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1030

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) 


1036
1037
1038
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1036

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1041
1042
1043
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1041

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) 


1046
1047
1048
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1046

def update_time
  @update_time
end

#user_id ⇒ Fixnum

Deprecated. Unique ID of the user on whose behalf transfer is done. Corresponds to the JSON property userId

Returns:

  • (Fixnum) 


1051
1052
1053
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1051

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1058

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)
  @email_preferences = args[:email_preferences] if args.key?(:email_preferences)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error_status = args[:error_status] if args.key?(:error_status)
  @name = args[:name] if args.key?(:name)
  @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
  @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