REST リソース: projects.locations.dataSources

リソース: DataSource

データソースのメタデータを表します。メタデータだけで UI をレンダリングし、適切な OAuth トークンをリクエストできます。

JSON 表現 

{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum (TransferType),
  "supportsMultipleTransfers": boolean,
  "updateDeadlineSeconds": integer,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum (AuthorizationType),
  "dataRefreshType": enum (DataRefreshType),
  "defaultDataRefreshWindowDays": integer,
  "manualRunsDisabled": boolean,
  "minimumScheduleInterval": string
}
フィールド
name

string

出力のみ。データソースのリソース名。
dataSourceId

string

データソースの ID。
displayName

string

わかりやすいデータソース名。
description

string

わかりやすいデータソースの説明。
clientId

string

更新トークンの取得に使用するデータソースのクライアント ID。
scopes[]

string

更新トークンを取得する API auth スコープ。これらのスコープは、データソースがデータを準備し、BigQuery に取り込む場合に必要になります（たとえば、https://www.googleapis.com/auth/bigquery）。
transferType
(deprecated)

enum (TransferType)

非推奨。このフィールドは無視されます。
supportsMultipleTransfers
(deprecated)

boolean

非推奨。このフィールドは無視されます。
updateDeadlineSeconds

integer

Data Transfer Service が転送を失敗としてマークするまで、データソースからの更新を待機する秒数。
defaultSchedule

string

デフォルトのデータ転送スケジュール。有効なスケジュールの例: 1st,3rd monday of month 15:30、every wed,fri of jan,jun 13:15、first sunday of quarter 00:00。
supportsCustomSchedule

boolean

データソースがユーザー定義のスケジュールをサポートするのか、デフォルトのスケジュールを使用するのかを指定します。true に設定すると、ユーザーがデフォルトのスケジュールを上書きできます。
parameters[]

object (DataSourceParameter)

データソースのパラメータ。
helpUrl

string

このデータソースのヘルプ ドキュメントの URI。
authorizationType

enum (AuthorizationType)

認証タイプを表します。
dataRefreshType

enum (DataRefreshType)

データソースが過去数日分のデータの自動更新をサポートするかどうかを指定します。サポートする場合には、その方法も設定します。データソースによっては、データが完了するまでに数日かかる場合があります。この場合、データの自動更新は便利な機能です。
defaultDataRefreshWindowDays

integer

デフォルトのデータ更新ウィンドウ（日数）。dataRefreshType = SLIDING_WINDOW の場合にのみ有効です。
manualRunsDisabled

boolean

データソースのバックフィルと手動実行スケジュールを無効にします。
minimumScheduleInterval

string (Duration format)

スケジューラが実行をスケジュールする最小間隔。

小数 9 桁まで、「s」で終わる秒単位の期間（例: "3.5s"）。

メソッド

checkValidCreds

 指定されたデータソースとリクエストしているユーザーに有効な認証情報が存在する場合、true を返します。

get

 サポートされるデータソースを取得し、設定を返します。この設定は UI のレンダリングに使用できます。

list

 サポートされるデータソースのリストを作成し、その設定を返します。この設定は UI のレンダリングに使用できます。