Class Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig (v0.4.6)

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#data_refresh_window_days

def data_refresh_window_days() -> ::Integer
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.

#data_refresh_window_days=

def data_refresh_window_days=(value) -> ::Integer
Parameter
  • value (::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.
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.

#data_source_id

def data_source_id() -> ::String
Returns
  • (::String) — Data source id. Cannot be changed once data transfer is created.

#data_source_id=

def data_source_id=(value) -> ::String
Parameter
  • value (::String) — Data source id. Cannot be changed once data transfer is created.
Returns
  • (::String) — Data source id. Cannot be changed once data transfer is created.

#dataset_region

def dataset_region() -> ::String
Returns
  • (::String) — Output only. Region in which BigQuery dataset is located.

#destination_dataset_id

def destination_dataset_id() -> ::String
Returns
  • (::String) — The BigQuery target dataset id.

#destination_dataset_id=

def destination_dataset_id=(value) -> ::String
Parameter
  • value (::String) — The BigQuery target dataset id.
Returns
  • (::String) — The BigQuery target dataset id.

#disabled

def disabled() -> ::Boolean
Returns
  • (::Boolean) — Is this config disabled. When set to true, no runs are scheduled for a given transfer.

#disabled=

def disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Is this config disabled. When set to true, no runs are scheduled for a given transfer.
Returns
  • (::Boolean) — Is this config disabled. When set to true, no runs are scheduled for a given transfer.

#display_name

def display_name() -> ::String
Returns
  • (::String) — User specified display name for the data transfer.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — User specified display name for the data transfer.
Returns
  • (::String) — User specified display name for the data transfer.

#email_preferences

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

#email_preferences=

def email_preferences=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::EmailPreferences
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/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}/locations/{region}/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.

#next_run_time

def next_run_time() -> ::Google::Protobuf::Timestamp
Returns

#notification_pubsub_topic

def notification_pubsub_topic() -> ::String
Returns
  • (::String) — Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

    The format for specifying a pubsub topic is: projects/{project}/topics/{topic}

#notification_pubsub_topic=

def notification_pubsub_topic=(value) -> ::String
Parameter
  • value (::String) — Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

    The format for specifying a pubsub topic is: projects/{project}/topics/{topic}

Returns
  • (::String) — Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

    The format for specifying a pubsub topic is: projects/{project}/topics/{topic}

#params

def params() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — 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

#params=

def params=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — 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
Returns
  • (::Google::Protobuf::Struct) — 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

#schedule

def schedule() -> ::String
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.

#schedule=

def schedule=(value) -> ::String
Parameter
  • value (::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.
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.

#schedule_options

def schedule_options() -> ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleOptions
Returns

#schedule_options=

def schedule_options=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleOptions
Parameter
Returns

#state

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

#update_time

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

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