Class: Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/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.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data_source_id ⇒ ::String

Returns Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list.

Returns:



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dataset_region ⇒ ::String (readonly)

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

Returns:

  • (::String) —

    Output only. Region in which BigQuery dataset is located.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#destination_dataset_id ⇒ ::String

Returns The BigQuery target dataset id.

Returns:

  • (::String) —

    The BigQuery target dataset id.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#disabled ⇒ ::Boolean

Returns Is this config disabled. When set to true, no runs will be scheduled for this transfer config.

Returns:

  • (::Boolean) —

    Is this config disabled. When set to true, no runs will be scheduled for this transfer config.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns User specified display name for the data transfer.

Returns:

  • (::String) —

    User specified display name for the data transfer.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

Returns:



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#encryption_configuration ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::EncryptionConfiguration

Returns The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

Returns:

  • (::Google::Cloud::Bigquery::DataTransfer::V1::EncryptionConfiguration) —

    The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#error ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. Error code with detailed information about reason of the latest config failure.

Returns:

  • (::Google::Rpc::Status) —

    Output only. Error code with detailed information about reason of the latest config failure.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or 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) —

    Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or 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.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#next_run_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#notification_pubsub_topic ⇒ ::String

Returns 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_id}/topics/{topic_id}.

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_id}/topics/{topic_id}



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#owner_info ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::UserInfo (readonly)

Returns Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

Returns:

  • (::Google::Cloud::Bigquery::DataTransfer::V1::UserInfo) —

    Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#params ⇒ ::Google::Protobuf::Struct

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



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#schedule_options ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleOptions

Returns Options customizing the data transfer schedule.

Returns:



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#schedule_options_v2 ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleOptionsV2

Returns Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

Returns:



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#state ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferState (readonly)

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

Returns:



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  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.

Returns:

  • (::Integer) —

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



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 251

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end