Class: Google::Cloud::Bigquery::DataTransfer::V1::TransferRun
- Inherits:
-
Object
- Object
- Google::Cloud::Bigquery::DataTransfer::V1::TransferRun
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb
Overview
Represents a data transfer run.
Instance Attribute Summary collapse
-
#data_source_id ⇒ ::String
readonly
Output only.
-
#destination_dataset_id ⇒ ::String
readonly
Output only.
-
#email_preferences ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences
readonly
Output only.
-
#end_time ⇒ ::Google::Protobuf::Timestamp
readonly
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
readonly
Output only.
-
#params ⇒ ::Google::Protobuf::Struct
readonly
Output only.
-
#run_time ⇒ ::Google::Protobuf::Timestamp
For batch transfer runs, specifies the date and time of the data should be ingested.
-
#schedule ⇒ ::String
readonly
Output only.
-
#schedule_time ⇒ ::Google::Protobuf::Timestamp
Minimum time after which a transfer run can be started.
-
#start_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#state ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferState
Data transfer run state.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#user_id ⇒ ::Integer
Deprecated.
Instance Attribute Details
#data_source_id ⇒ ::String (readonly)
Returns Output only. Data source id.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#destination_dataset_id ⇒ ::String (readonly)
Returns Output only. The BigQuery target dataset id.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#email_preferences ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences (readonly)
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.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. Time when transfer run ended. Parameter ignored by server for input requests.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#error_status ⇒ ::Google::Rpc::Status
Returns Status of the transfer run.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#notification_pubsub_topic ⇒ ::String (readonly)
Returns 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}
.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#params ⇒ ::Google::Protobuf::Struct (readonly)
Returns 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.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#run_time ⇒ ::Google::Protobuf::Timestamp
Returns For batch transfer runs, specifies the date and time of the data should be ingested.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#schedule ⇒ ::String (readonly)
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.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#schedule_time ⇒ ::Google::Protobuf::Timestamp
Returns Minimum time after which a transfer run can be started.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. Time when transfer run was started. Parameter ignored by server for input requests.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#state ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferState
Returns Data transfer run state. Ignored for input requests.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. Last time the data transfer run state was updated.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#user_id ⇒ ::Integer
Returns Deprecated. Unique ID of the user on whose behalf transfer is done.
214 215 216 217 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 214 class TransferRun include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |