Class: Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/transfer.rb

Overview

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, +destination_dataset_id+ specifies where data should be stored. When a new transfer configuration is created, the specified +destination_dataset_id+ is created when needed and shared with the appropriate data source service account.

Instance Attribute Summary collapse

Instance Attribute Details

#data_refresh_window_days ⇒ Integer

Returns The number of days to look back to automatically refresh the data. For example, if +data_refresh_window_days = 10+, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.

Returns:

  • (Integer) —

    The number of days to look back to automatically refresh the data. For example, if +data_refresh_window_days = 10+, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.



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

class TransferConfig; end

#data_source_id ⇒ String

Returns Data source id. Cannot be changed once data transfer is created.

Returns:

  • (String) —

    Data source id. Cannot be changed once data transfer is created.



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

class TransferConfig; end

#dataset_region ⇒ String

Returns Output only. Region in which BigQuery dataset is located.

Returns:

  • (String) —

    Output only. Region in which BigQuery dataset is located.



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

class TransferConfig; end

#destination_dataset_id ⇒ String

Returns The BigQuery target dataset id.

Returns:

  • (String) —

    The BigQuery target dataset id.



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

class TransferConfig; end

#disabled ⇒ true, false

Returns Is this config disabled. When set to true, no runs are scheduled for a given transfer.

Returns:

  • (true, false) —

    Is this config disabled. When set to true, no runs are scheduled for a given transfer.



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

class TransferConfig; end

#display_name ⇒ String

Returns User specified display name for the data transfer.

Returns:

  • (String) —

    User specified display name for the data transfer.



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

class TransferConfig; end

#name ⇒ String

Returns The resource name of the transfer config. Transfer config names have the form +projects/{project_id}/transferConfigs/{config_id}+. Where +config_id+ is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

Returns:

  • (String) —

    The resource name of the transfer config. Transfer config names have the form +projects/{project_id}/transferConfigs/{config_id}+. Where +config_id+ is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.



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

class TransferConfig; end

#next_run_time ⇒ Google::Protobuf::Timestamp

Returns Output only. Next time when data transfer will run.

Returns:



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

class TransferConfig; end

#params ⇒ Google::Protobuf::Struct

Returns Data transfer specific parameters.

Returns:



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

class TransferConfig; end

#schedule ⇒ String

Returns Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: +1st,3rd monday of month 15:30+, +every wed,fri of jan,jun 13:15+, and +first sunday of quarter 00:00+. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.

Returns:

  • (String) —

    Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: +1st,3rd monday of month 15:30+, +every wed,fri of jan,jun 13:15+, and +first sunday of quarter 00:00+. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.



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

class TransferConfig; end

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

Returns Output only. State of the most recently updated transfer run.

Returns:



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

class TransferConfig; end

#update_time ⇒ Google::Protobuf::Timestamp

Returns Output only. Data transfer modification time. Ignored by server on input.

Returns:



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

class TransferConfig; end

#user_id ⇒ Integer

Returns Output only. Unique ID of the user on whose behalf transfer is done. Applicable only to data sources that do not support service accounts. When set to 0, the data source service account credentials are used. May be negative. Note, that this identifier is not stable. It may change over time even for the same user.

Returns:

  • (Integer) —

    Output only. Unique ID of the user on whose behalf transfer is done. Applicable only to data sources that do not support service accounts. When set to 0, the data source service account credentials are used. May be negative. Note, that this identifier is not stable. It may change over time even for the same user.



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

class TransferConfig; end