Class DataSource (3.13.0)

Version 3.13.0

• 3.18.0 (latest)
• 3.17.1
• 3.16.0
• 3.15.7
• 3.14.1
• 3.13.0
• 3.12.1
• 3.11.2
• 3.10.1
• 3.9.0
• 3.8.0
• 3.7.3
• 3.6.2
• 3.5.0
• 3.4.1
• 3.3.4
• 3.2.0
• 3.1.1
• 3.0.1
• 2.1.2
• 2.0.0
• 1.1.3
• 1.0.0
• 0.4.1

DataSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Defines the properties and custom parameters for a data source.

Attributes
Name	Description
name	str Output only. Data source resource name.
data_source_id	str Data source id.
display_name	str User friendly data source name.
description	str User friendly data source description string.
client_id	str Data source client id which should be used to receive refresh token.
scopes	MutableSequence[str] 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
transfer_type	google.cloud.bigquery_datatransfer_v1.types.TransferType Deprecated. This field has no effect.
supports_multiple_transfers	bool Deprecated. This field has no effect.
update_deadline_seconds	int The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
default_schedule	str 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.
supports_custom_schedule	bool 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.
parameters	MutableSequence[google.cloud.bigquery_datatransfer_v1.types.DataSourceParameter] Data source parameters.
help_url	str Url for the help document for this data source.
authorization_type	google.cloud.bigquery_datatransfer_v1.types.DataSource.AuthorizationType Indicates the type of authorization.
data_refresh_type	google.cloud.bigquery_datatransfer_v1.types.DataSource.DataRefreshType Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
default_data_refresh_window_days	int Default data refresh window on days. Only meaningful when data_refresh_type = SLIDING_WINDOW.
manual_runs_disabled	bool Disables backfilling and manual run scheduling for the data source.
minimum_schedule_interval	google.protobuf.duration_pb2.Duration The minimum interval for scheduler to schedule runs.

Classes

AuthorizationType

AuthorizationType(value)

The type of authorization needed for this data source.

Values: AUTHORIZATION_TYPE_UNSPECIFIED (0): Type unspecified. AUTHORIZATION_CODE (1): Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend. GOOGLE_PLUS_AUTHORIZATION_CODE (2): Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend. FIRST_PARTY_OAUTH (3): Use First Party OAuth.

DataRefreshType

DataRefreshType(value)

Represents how the data source supports data auto refresh.

Values: DATA_REFRESH_TYPE_UNSPECIFIED (0): The data source won't support data auto refresh, which is default value. SLIDING_WINDOW (1): The data source supports data auto refresh, and runs will be scheduled for the past few days. Does not allow custom values to be set for each transfer config. CUSTOM_SLIDING_WINDOW (2): The data source supports data auto refresh, and runs will be scheduled for the past few days. Allows custom values to be set for each transfer config.