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



954
955
956
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 954

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) 


843
844
845
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 843

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) 


848
849
850
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 848

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) 


854
855
856
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 854

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. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs # Overview The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions. # Language mapping The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include:
  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. Corresponds to the JSON property errorStatus

Returns:



897
898
899
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 897

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 propertyname`

Returns:

  • (String) 


906
907
908
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 906

def name
  @name
end

#params ⇒ Hash<String,Object>

Output only. Data transfer specific parameters. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


911
912
913
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 911

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) 


917
918
919
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 917

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) 


926
927
928
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 926

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) 


931
932
933
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 931

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) 


937
938
939
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 937

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


942
943
944
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 942

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) 


947
948
949
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 947

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) 


952
953
954
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 952

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 959

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