Class: Google::Cloud::Bigquery::Datatransfer::V1::TransferRun

Inherits:

Object

• Object
• Google::Cloud::Bigquery::Datatransfer::V1::TransferRun

Defined in:

lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb

Overview

Represents a data transfer run.

Instance Attribute Summary

• #data_source_id ⇒ String

  Output only.

• #destination_dataset_id ⇒ String

  Output only.

• #email_preferences ⇒ Google::Cloud::Bigquery::Datatransfer::V1::EmailPreferences

  Output only.

• #end_time ⇒ Google::Protobuf::Timestamp

  Output only.

• #error_status ⇒ Google::Rpc::Status

  Status of the transfer run.

• #name ⇒ String

  The resource name of the transfer run.

• #notification_pubsub_topic ⇒ String

  Output only.

• #params ⇒ Google::Protobuf::Struct

  Output only.

• #run_time ⇒ Google::Protobuf::Timestamp

  For batch transfer runs, specifies the date and time of the data should be ingested.

• #schedule ⇒ String

  Output only.

• #schedule_time ⇒ Google::Protobuf::Timestamp

  Minimum time after which a transfer run can be started.

• #start_time ⇒ Google::Protobuf::Timestamp

  Output only.

• #state ⇒ Google::Cloud::Bigquery::Datatransfer::V1::TransferState

  Data transfer run state.

• #update_time ⇒ Google::Protobuf::Timestamp

  Output only.

• #user_id ⇒ Integer

  Deprecated.

Instance Attribute Details

#data_source_id ⇒ String

Returns Output only. Data source id.

Returns:

• (String) —

  Output only. Data source id.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#destination_dataset_id ⇒ String

Returns Output only. The BigQuery target dataset id.

Returns:

• (String) —

  Output only. The BigQuery target dataset id.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#email_preferences ⇒ Google::Cloud::Bigquery::Datatransfer::V1::EmailPreferences

Returns Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.

Returns:

• (Google::Cloud::Bigquery::Datatransfer::V1::EmailPreferences) —

  Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#end_time ⇒ Google::Protobuf::Timestamp

Returns Output only. Time when transfer run ended. Parameter ignored by server for input requests.

Returns:

• (Google::Protobuf::Timestamp) —

  Output only. Time when transfer run ended. Parameter ignored by server for input requests.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#error_status ⇒ Google::Rpc::Status

Returns Status of the transfer run.

Returns:

• (Google::Rpc::Status) —

  Status of the transfer run.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#name ⇒ String

Returns 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.

Returns:

• (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.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#notification_pubsub_topic ⇒ String

Returns Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes.

Returns:

• (String) —

  Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#params ⇒ Google::Protobuf::Struct

Returns Output only. Data transfer specific parameters.

Returns:

• (Google::Protobuf::Struct) —

  Output only. Data transfer specific parameters.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#run_time ⇒ Google::Protobuf::Timestamp

Returns For batch transfer runs, specifies the date and time of the data should be ingested.

Returns:

• (Google::Protobuf::Timestamp) —

  For batch transfer runs, specifies the date and time of the data should be ingested.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#schedule ⇒ String

Returns 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.

Returns:

• (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.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#schedule_time ⇒ Google::Protobuf::Timestamp

Returns Minimum time after which a transfer run can be started.

Returns:

• (Google::Protobuf::Timestamp) —

  Minimum time after which a transfer run can be started.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#start_time ⇒ Google::Protobuf::Timestamp

Returns Output only. Time when transfer run was started. Parameter ignored by server for input requests.

Returns:

• (Google::Protobuf::Timestamp) —

  Output only. Time when transfer run was started. Parameter ignored by server for input requests.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#state ⇒ Google::Cloud::Bigquery::Datatransfer::V1::TransferState

Returns Data transfer run state. Ignored for input requests.

Returns:

• (Google::Cloud::Bigquery::Datatransfer::V1::TransferState) —

  Data transfer run state. Ignored for input requests.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#update_time ⇒ Google::Protobuf::Timestamp

Returns Output only. Last time the data transfer run state was updated.

Returns:

• (Google::Protobuf::Timestamp) —

  Output only. Last time the data transfer run state was updated.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end

#user_id ⇒ Integer

Returns Deprecated. Unique ID of the user on whose behalf transfer is done.

Returns:

• (Integer) —

  Deprecated. Unique ID of the user on whose behalf transfer is done.

# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 190

class TransferRun; end