BigQuery Data Transfer Service V1 API - Class Google::Cloud::Bigquery::DataTransfer::V1::TransferRun (v1.2.0)

Reference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::TransferRun.

Represents a data transfer run.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#data_source_id

def data_source_id() -> ::String

Returns

(::String) — Output only. Data source id.

#destination_dataset_id

def destination_dataset_id() -> ::String

Returns

(::String) — Output only. The BigQuery target dataset id.

#email_preferences

def email_preferences() -> ::Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences

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.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when transfer run ended. Parameter ignored by server for input requests.

#error_status

def error_status() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — Status of the transfer run.

#error_status=

def error_status=(value) -> ::Google::Rpc::Status

Parameter

value (::Google::Rpc::Status) — Status of the transfer run.

Returns

(::Google::Rpc::Status) — Status of the transfer run.

#name

def name() -> ::String

Returns

(::String) — Identifier. 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.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Identifier. 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) — Identifier. 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.

#notification_pubsub_topic

def notification_pubsub_topic() -> ::String

Returns

(::String) — 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_id}/topics/{topic_id}

#params

def params() -> ::Google::Protobuf::Struct

Returns

(::Google::Protobuf::Struct) — 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

#run_time

def run_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — For batch transfer runs, specifies the date and time of the data should be ingested.

#run_time=

def run_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — 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.

#schedule

def schedule() -> ::String

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.

#schedule_time

def schedule_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Minimum time after which a transfer run can be started.

#schedule_time=

def schedule_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Minimum time after which a transfer run can be started.

Returns

(::Google::Protobuf::Timestamp) — Minimum time after which a transfer run can be started.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when transfer run was started. Parameter ignored by server for input requests.

#state

def state() -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferState

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::TransferState) — Data transfer run state. Ignored for input requests.

#state=

def state=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferState

Parameter

value (::Google::Cloud::Bigquery::DataTransfer::V1::TransferState) — Data transfer run state. Ignored for input requests.

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::TransferState) — Data transfer run state. Ignored for input requests.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Last time the data transfer run state was updated.

#user_id

def user_id() -> ::Integer

Returns

(::Integer) — Deprecated. Unique ID of the user on whose behalf transfer is done.

#user_id=

def user_id=(value) -> ::Integer

Parameter

value (::Integer) — 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.