REST Resource: projects.locations.dataSources

Resource: DataSource

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

JSON representation
{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum(TransferType),
  "supportsMultipleTransfers": boolean,
  "updateDeadlineSeconds": number,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object(DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum(AuthorizationType),
  "dataRefreshType": enum(DataRefreshType),
  "defaultDataRefreshWindowDays": number,
  "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(TransferType)

Deprecated. This field has no effect.

supportsMultipleTransfers
(deprecated)

boolean

Deprecated. This field has no effect.

updateDeadlineSeconds

number

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(DataSourceParameter)

Data source parameters.

helpUrl

string

Url for the help document for this data source.

authorizationType

enum(AuthorizationType)

Indicates the type of authorization.

dataRefreshType

enum(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

number

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 (Duration format)

The minimum interval for scheduler to schedule runs.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

Methods

checkValidCreds

Returns true if valid credentials exist for the given data source and requesting user.

get

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

list

Lists supported data sources and returns their settings, which can be used for UI rendering.
Was this page helpful? Let us know how we did:

Send feedback about...