# REST Resource: projects.locations.dataSources

- [Resource: DataSource](https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.locations.dataSources#DataSource)
  - [JSON representation](https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.locations.dataSources#DataSource.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.locations.dataSources#METHODS_SUMMARY)

## 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 (`https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.dataSources#DataSource.TransferType`), "supportsMultipleTransfers": boolean, "updateDeadlineSeconds": integer, "defaultSchedule": string, "supportsCustomSchedule": boolean, "parameters": [ { object (`https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.dataSources#DataSource.DataSourceParameter`) } ], "helpUrl": string, "authorizationType": enum (`https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.dataSources#DataSource.AuthorizationType`), "dataRefreshType": enum (`https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.dataSources#DataSource.DataRefreshType`), "defaultDataRefreshWindowDays": integer, "manualRunsDisabled": boolean, "minimumScheduleInterval": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. Data source resource name. |
| `dataSourceId` | `string` Data source id. |
| `displayName` | `string` User friendly data source name. |
| `description` | `string` User friendly data source description string. |
| `clientId` | `string` Data source client id which should be used to receive refresh token. |
| `scopes[]` | `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> |
| `transferType (deprecated)` | ``enum (`https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.dataSources#DataSource.TransferType`)`` > [!WARNING] > This item is deprecated! Deprecated. This field has no effect. |
| `supportsMultipleTransfers (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Deprecated. This field has no effect. |
| `updateDeadlineSeconds` | `integer` The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. |
| `defaultSchedule` | `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`. |
| `supportsCustomSchedule` | `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. |
| `parameters[]` | ``object (`https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.dataSources#DataSource.DataSourceParameter`)`` Data source parameters. |
| `helpUrl` | `string` Url for the help document for this data source. |
| `authorizationType` | ``enum (`https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.dataSources#DataSource.AuthorizationType`)`` Indicates the type of authorization. |
| `dataRefreshType` | ``enum (`https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.dataSources#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. |
| `defaultDataRefreshWindowDays` | `integer` Default data refresh window on days. Only meaningful when `dataRefreshType` = `SLIDING_WINDOW`. |
| `manualRunsDisabled` | `boolean` Disables backfilling and manual run scheduling for the data source. |
| `minimumScheduleInterval` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#duration` format)`` The minimum interval for scheduler to schedule runs. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/checkValidCreds` | Returns true if valid credentials exist for the given data source and requesting user. |
| ### `https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/get` | Retrieves a supported data source and returns its settings. |
| ### `https://docs.cloud.google.com/bigquery/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list` | Lists supported data sources and returns their settings. |