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.



1197
1198
1199
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1197

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) 


1107
1108
1109
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1107

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) 


1112
1113
1114
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1112

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:



1117
1118
1119
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1117

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) 


1123
1124
1125
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1123

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:



1133
1134
1135
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1133

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) 


1140
1141
1142
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1140

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) 


1147
1148
1149
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1147

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


1155
1156
1157
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1155

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) 


1161
1162
1163
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1161

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) 


1169
1170
1171
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1169

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) 


1174
1175
1176
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1174

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) 


1180
1181
1182
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1180

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1185
1186
1187
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1185

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) 


1190
1191
1192
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1190

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) 


1195
1196
1197
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1195

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 1202

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