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.



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

class TransferConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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.



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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.



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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 are scheduled for a given transfer.

Returns:

  • (::Boolean) —

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



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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.



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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:



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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

#name ⇒ ::String

Returns The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.

Returns:

  • (::String) —

    The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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:



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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.

Returns:

  • (::String) —

    Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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

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

Returns Data transfer specific parameters.

Returns:



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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:



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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:



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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:



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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.



139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 139

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