Class DataSource (3.3.4)

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

Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.

Attributes

NameDescription
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 Sequence[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 Sequence[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.

DataRefreshType

DataRefreshType(value)

Represents how the data source supports data auto refresh.