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.


995
996
997
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 995

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#data_source_idString

Output only. Data source id. Corresponds to the JSON property dataSourceId

Returns:

  • (String)

909
910
911
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 909

def data_source_id
  @data_source_id
end

#destination_dataset_idString

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

Returns:

  • (String)

914
915
916
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 914

def destination_dataset_id
  @destination_dataset_id
end

#email_preferencesGoogle::Apis::BigquerydatatransferV1::EmailPreferences

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


919
920
921
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 919

def email_preferences
  @email_preferences
end

#end_timeString

Output only. Time when transfer run ended. Parameter ignored by server for input requests. Corresponds to the JSON property endTime

Returns:

  • (String)

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

def end_time
  @end_time
end

#error_statusGoogle::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


935
936
937
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 935

def error_status
  @error_status
end

#nameString

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)

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

def name
  @name
end

#notification_pubsub_topicString

Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes Corresponds to the JSON property notificationPubsubTopic

Returns:

  • (String)

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

def notification_pubsub_topic
  @notification_pubsub_topic
end

#paramsHash<String,Object>

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

Returns:

  • (Hash<String,Object>)

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

def params
  @params
end

#run_timeString

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

Returns:

  • (String)

959
960
961
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 959

def run_time
  @run_time
end

#scheduleString

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)

967
968
969
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 967

def schedule
  @schedule
end

#schedule_timeString

Minimum time after which a transfer run can be started. Corresponds to the JSON property scheduleTime

Returns:

  • (String)

972
973
974
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 972

def schedule_time
  @schedule_time
end

#start_timeString

Output only. Time when transfer run was started. Parameter ignored by server for input requests. Corresponds to the JSON property startTime

Returns:

  • (String)

978
979
980
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 978

def start_time
  @start_time
end

#stateString

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

Returns:

  • (String)

983
984
985
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 983

def state
  @state
end

#update_timeString

Output only. Last time the data transfer run state was updated. Corresponds to the JSON property updateTime

Returns:

  • (String)

988
989
990
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 988

def update_time
  @update_time
end

#user_idFixnum

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

Returns:

  • (Fixnum)

993
994
995
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 993

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 1000

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