Class: Google::Apis::BigquerydatatransferV1::TransferRun
- Inherits:
-
Object
- Object
- Google::Apis::BigquerydatatransferV1::TransferRun
- 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
-
#data_source_id ⇒ String
Output only.
-
#destination_dataset_id ⇒ String
Output only.
-
#email_preferences ⇒ Google::Apis::BigquerydatatransferV1::EmailPreferences
Represents preferences for sending email notifications for transfer run events.
-
#end_time ⇒ String
Output only.
-
#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. -
#name ⇒ String
The resource name of the transfer run.
-
#notification_pubsub_topic ⇒ String
Output only.
-
#params ⇒ Hash<String,Object>
Output only.
-
#run_time ⇒ String
For batch transfer runs, specifies the date and time of the data should be ingested.
-
#schedule ⇒ String
Output only.
-
#schedule_time ⇒ String
Minimum time after which a transfer run can be started.
-
#start_time ⇒ String
Output only.
-
#state ⇒ String
Data transfer run state.
-
#update_time ⇒ String
Output only.
-
#user_id ⇒ Fixnum
Deprecated.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TransferRun
constructor
A new instance of TransferRun.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ TransferRun
Returns a new instance of TransferRun.
1021 1022 1023 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 1021 def initialize(**args) update!(**args) end |
Instance Attribute Details
#data_source_id ⇒ String
Output only. Data source id.
Corresponds to the JSON property dataSourceId
931 932 933 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 931 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
936 937 938 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 936 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
942 943 944 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 942 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
948 949 950 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 948 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
958 959 960 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 958 def error_status @error_status 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 property
name`
967 968 969 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 967 def name @name end |
#notification_pubsub_topic ⇒ String
Output only. Pub/Sub topic where a notification will be sent after this
transfer run finishes
Corresponds to the JSON property notificationPubsubTopic
973 974 975 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 973 def notification_pubsub_topic @notification_pubsub_topic end |
#params ⇒ Hash<String,Object>
Output only. Data transfer specific parameters.
Corresponds to the JSON property params
978 979 980 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 978 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
984 985 986 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 984 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
993 994 995 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 993 def schedule @schedule end |
#schedule_time ⇒ String
Minimum time after which a transfer run can be started.
Corresponds to the JSON property scheduleTime
998 999 1000 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 998 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
1004 1005 1006 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 1004 def start_time @start_time end |
#state ⇒ String
Data transfer run state. Ignored for input requests.
Corresponds to the JSON property state
1009 1010 1011 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 1009 def state @state end |
#update_time ⇒ String
Output only. Last time the data transfer run state was updated.
Corresponds to the JSON property updateTime
1014 1015 1016 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 1014 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
1019 1020 1021 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 1019 def user_id @user_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 1026 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 |