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

Inherits:

Object

• Object
• Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

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

• #data_refresh_window_days ⇒ ::Integer

  The number of days to look back to automatically refresh the data.

• #data_source_id ⇒ ::String

  Data source ID.

• #dataset_region ⇒ ::String readonly

  Output only.

• #destination_dataset_id ⇒ ::String

  The BigQuery target dataset id.

• #disabled ⇒ ::Boolean

  Is this config disabled.

• #display_name ⇒ ::String

  User specified display name for the data transfer.

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

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

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

  The encryption configuration part.

• #error ⇒ ::Google::Rpc::Status readonly

  Output only.

• #name ⇒ ::String

  Identifier.

• #next_run_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #notification_pubsub_topic ⇒ ::String

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

• #owner_info ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::UserInfo readonly

  Output only.

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

  Parameters specific to each data source.

• #schedule ⇒ ::String

  Data transfer schedule.

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

  Options customizing the data transfer schedule.

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

  Options customizing different types of data transfer schedule.

• #state ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferState readonly

  Output only.

• #update_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #user_id ⇒ ::Integer

  Deprecated.

Instance Attribute Details

#data_refresh_window_days ⇒ ::Integer

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#data_source_id ⇒ ::String

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#dataset_region ⇒ ::String (readonly)

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#destination_dataset_id ⇒ ::String

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#disabled ⇒ ::Boolean

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#display_name ⇒ ::String

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#name ⇒ ::String

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#notification_pubsub_topic ⇒ ::String

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#schedule ⇒ ::String

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

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

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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

#user_id ⇒ ::Integer

# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb', line 257

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