BigQuery Data Transfer Service V1 API - Class Google::Cloud::Bigquery::DataTransfer::V1::DataSource (v0.5.1)

Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::DataSource.

Defines the properties and custom parameters for a data source.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#authorization_type

def authorization_type() -> ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource::AuthorizationType
Returns

#authorization_type=

def authorization_type=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource::AuthorizationType
Parameter
Returns

#client_id

def client_id() -> ::String
Returns
  • (::String) — Data source client id which should be used to receive refresh token.

#client_id=

def client_id=(value) -> ::String
Parameter
  • value (::String) — Data source client id which should be used to receive refresh token.
Returns
  • (::String) — Data source client id which should be used to receive refresh token.

#data_refresh_type

def data_refresh_type() -> ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource::DataRefreshType
Returns

#data_refresh_type=

def data_refresh_type=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource::DataRefreshType
Parameter
Returns

#data_source_id

def data_source_id() -> ::String
Returns
  • (::String) — Data source id.

#data_source_id=

def data_source_id=(value) -> ::String
Parameter
  • value (::String) — Data source id.
Returns
  • (::String) — Data source id.

#default_data_refresh_window_days

def default_data_refresh_window_days() -> ::Integer
Returns
  • (::Integer) — Default data refresh window on days. Only meaningful when data_refresh_type = SLIDING_WINDOW.

#default_data_refresh_window_days=

def default_data_refresh_window_days=(value) -> ::Integer
Parameter
  • value (::Integer) — Default data refresh window on days. Only meaningful when data_refresh_type = SLIDING_WINDOW.
Returns
  • (::Integer) — Default data refresh window on days. Only meaningful when data_refresh_type = SLIDING_WINDOW.

#default_schedule

def default_schedule() -> ::String
Returns
  • (::String) — Default data transfer schedule. Examples of valid schedules include: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00.

#default_schedule=

def default_schedule=(value) -> ::String
Parameter
  • value (::String) — Default data transfer schedule. Examples of valid schedules include: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00.
Returns
  • (::String) — Default data transfer schedule. Examples of valid schedules include: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00.

#description

def description() -> ::String
Returns
  • (::String) — User friendly data source description string.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — User friendly data source description string.
Returns
  • (::String) — User friendly data source description string.

#display_name

def display_name() -> ::String
Returns
  • (::String) — User friendly data source name.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — User friendly data source name.
Returns
  • (::String) — User friendly data source name.

#help_url

def help_url() -> ::String
Returns
  • (::String) — Url for the help document for this data source.

#help_url=

def help_url=(value) -> ::String
Parameter
  • value (::String) — Url for the help document for this data source.
Returns
  • (::String) — Url for the help document for this data source.

#manual_runs_disabled

def manual_runs_disabled() -> ::Boolean
Returns
  • (::Boolean) — Disables backfilling and manual run scheduling for the data source.

#manual_runs_disabled=

def manual_runs_disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Disables backfilling and manual run scheduling for the data source.
Returns
  • (::Boolean) — Disables backfilling and manual run scheduling for the data source.

#minimum_schedule_interval

def minimum_schedule_interval() -> ::Google::Protobuf::Duration
Returns

#minimum_schedule_interval=

def minimum_schedule_interval=(value) -> ::Google::Protobuf::Duration
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Output only. Data source resource name.

#parameters

def parameters() -> ::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>
Returns

#parameters=

def parameters=(value) -> ::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>
Parameter
Returns

#scopes

def scopes() -> ::Array<::String>
Returns
  • (::Array<::String>) — Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery

#scopes=

def scopes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
Returns
  • (::Array<::String>) — Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery

#supports_custom_schedule

def supports_custom_schedule() -> ::Boolean
Returns
  • (::Boolean) — Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to true, user can override default schedule.

#supports_custom_schedule=

def supports_custom_schedule=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to true, user can override default schedule.
Returns
  • (::Boolean) — Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to true, user can override default schedule.

#supports_multiple_transfers

def supports_multiple_transfers() -> ::Boolean
Returns
  • (::Boolean) — Deprecated. This field has no effect.

#supports_multiple_transfers=

def supports_multiple_transfers=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Deprecated. This field has no effect.
Returns
  • (::Boolean) — Deprecated. This field has no effect.

#transfer_type

def transfer_type() -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferType
Returns

#transfer_type=

def transfer_type=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferType
Parameter
Returns

#update_deadline_seconds

def update_deadline_seconds() -> ::Integer
Returns
  • (::Integer) — The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.

#update_deadline_seconds=

def update_deadline_seconds=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
Returns
  • (::Integer) — The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.