Resource: DataSource
Defines the properties and custom parameters for a data source.
JSON representation |
---|
{ "name" : string , "dataSourceId" : string , "displayName" : string , "description" : string , "clientId" : string , "scopes" : [ string ] , "transferType" : enum ( |
Fields | |
---|---|
name
|
Output only. Data source resource name. |
dataSourceId
|
Data source id. |
displayName
|
User friendly data source name. |
description
|
User friendly data source description string. |
clientId
|
Data source client id which should be used to receive refresh token. |
scopes[]
|
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 |
transferType
|
Deprecated. This field has no effect. |
supportsMultipleTransfers
|
Deprecated. This field has no effect. |
updateDeadlineSeconds
|
The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. |
defaultSchedule
|
Default data transfer schedule. Examples of valid schedules include: |
supportsCustomSchedule
|
Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to |
parameters[]
|
Data source parameters. |
helpUrl
|
Url for the help document for this data source. |
authorizationType
|
Indicates the type of authorization. |
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. |
defaultDataRefreshWindowDays
|
Default data refresh window on days. Only meaningful when |
manualRunsDisabled
|
Disables backfilling and manual run scheduling for the data source. |
minimumScheduleInterval
|
The minimum interval for scheduler to schedule runs. A duration in seconds with up to nine fractional digits, ending with ' |
Methods |
|
---|---|
|
Returns true if valid credentials exist for the given data source and requesting user. |
|
Retrieves a supported data source and returns its settings. |
|
Lists supported data sources and returns their settings. |