class Google::Apis::BigquerydatatransferV1::TransferRun

Represents a data transfer run.

Attributes

data_source_id[RW]

Output only. Data source id. Corresponds to the JSON property `dataSourceId` @return [String]

destination_dataset_id[RW]

Output only. The BigQuery target dataset id. Corresponds to the JSON property `destinationDatasetId` @return [String]

email_preferences[RW]

Represents preferences for sending email notifications for transfer run events. Corresponds to the JSON property `emailPreferences` @return [Google::Apis::BigquerydatatransferV1::EmailPreferences]

end_time[RW]

Output only. Time when transfer run ended. Parameter ignored by server for input requests. Corresponds to the JSON property `endTime` @return [String]

error_status[RW]

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](github.com/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](https: //cloud.google.com/apis/design/errors). Corresponds to the JSON property `errorStatus` @return [Google::Apis::BigquerydatatransferV1::Status]

name[RW]

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` @return [String]

notification_pubsub_topic[RW]

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`/topics/`topic“ Corresponds to the JSON property `notificationPubsubTopic` @return [String]

params[RW]

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` @return [Hash<String,Object>]

run_time[RW]

For batch transfer runs, specifies the date and time of the data should be ingested. Corresponds to the JSON property `runTime` @return [String]

schedule[RW]

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` @return [String]

schedule_time[RW]

Minimum time after which a transfer run can be started. Corresponds to the JSON property `scheduleTime` @return [String]

start_time[RW]

Output only. Time when transfer run was started. Parameter ignored by server for input requests. Corresponds to the JSON property `startTime` @return [String]

state[RW]

Data transfer run state. Ignored for input requests. Corresponds to the JSON property `state` @return [String]

update_time[RW]

Output only. Last time the data transfer run state was updated. Corresponds to the JSON property `updateTime` @return [String]

user_id[RW]

Deprecated. Unique ID of the user on whose behalf transfer is done. Corresponds to the JSON property `userId` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/bigquerydatatransfer_v1/classes.rb, line 1028
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/bigquerydatatransfer_v1/classes.rb, line 1033
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