REST リソース: projects.locations.dataSourceDefinitions

リソース: DataSourceDefinition
- JSON 表現
メソッド

リソース: DataSourceDefinition

データソース定義を表します。

JSON 表現

JSON 表現
{ "name": string, "dataSource": { object(`DataSource`) }, "transferRunPubsubTopic": string, "runTimeOffset": string, "supportEmail": string, "serviceAccount": string, "disabled": boolean, "transferConfigPubsubTopic": string, "supportedLocationIds": [ string ] }


{
  "name": string,
  "dataSource": {
    object(DataSource)
  },
  "transferRunPubsubTopic": string,
  "runTimeOffset": string,
  "supportEmail": string,
  "serviceAccount": string,
  "disabled": boolean,
  "transferConfigPubsubTopic": string,
  "supportedLocationIds": [
    string
  ]
}

フィールド
`name`	`string` データソース定義のリソース名。データソース定義名の形式は `projects/{projectId}/locations/{location}/dataSourceDefinitions/{dataSourceId}` です。
`dataSource`	`object(DataSource)` データソースメタデータ。
`transferRunPubsubTopic`	`string` 転送実行の作成時にメッセージをブロードキャストするために使用される Pub/Sub トピック。このトピックと transferConfigPubsubTopic はいずれもカスタムトピックに設定できます。デフォルトでは、定義の作成時にどちらのトピックも設定されなかった場合、両方のトピックが自動的に生成されます。ただし、1 つのトピックを手動で設定した場合は、もう 1 つのトピックも手動で設定する必要があります。唯一の違いは、transferRunPubsubTopic は空の Pub/Sub トピックにできませんが、transferConfigPubsubTopic は空に設定できる点です。transferConfigPubsubTopic の {location} に関するコメントもここで適用されます。
`runTimeOffset`	`string (Duration format)` ジョブのスケジュール時に runTime を計算するために scheduleTime に追加される期間。自動的にスケジュールされた転送実行にのみ適用されます。不明なタイムゾーンオフセットを補正するために連続データ更新をサポートするデータソースで早めに実行を開始するために使用されます。連続データ更新をサポートしていないデータソースの場合は、実行の開始を遅らせるために負数を使用します。小数 9 桁まで、「`s`」で終わる秒単位の期間（例: `"3.5s"`）。
`supportEmail`	`string` 同意画面データを含む OAuth クライアントのブランドのメールアドレスをサポートします。
`serviceAccount`	`string` サービスアカウントが指定された場合は、BigQuery が、作成されたデータセットを特定のサービスアカウントと共有します。また、このサービスアカウントは、対応する dataSourceId のデータ転送実行のステータス更新とメッセージロギングを実行する資格があります。
`disabled`	`boolean` データソースが無効になっているかどうか。true の場合は、dataSource が表示されません。API は、データ転送構成の返却やデータソースに関連付けられた実行も停止します。この設定は、whitelisted_project_ids より優先されます。
`transferConfigPubsubTopic`	`string` 転送構成のメッセージをブロードキャストするために使用する Pub/Sub トピック。空の場合、メッセージはブロードキャストされません。定義の作成時にどちらのトピックも設定されなかった場合、このトピックと transferRunPubsubTopic の両方が自動的に生成されます。ユーザー所有の transferRunPubsubTopic が指定されている場合は、transferConfigPubsubTopic を指定することをおすすめします。それ以外の場合は空に設定されます。値に {location} がある場合、データソースは異なるリージョンのデータセットに対して個別にメッセージを処理する必要があります。{location} は、トピック名として実際のデータセットのロケーションに置き換えます。たとえば、projects/connector/topics/scheduler-{location} は projects/connector/topics/scheduler-us になります。{location} がない場合は、トピック名として入力値を使用します。
`supportedLocationIds[]`	`string` Pub/Sub トピックの作成場所を決める際に使用される location_ids。カスタム Pub/Sub トピックを使用し、トピックに {location} が含まれている場合、location_ids はトピックの検証に使用されます。{location} は、リスト内の個々のロケーションで置き換えられます。有効な値は、`GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations` のレスポンスの locationId フィールドです。加えて、データソースで使用可能なすべてのリージョンをサポートする必要がある場合は、supportedLocationIds を global（単一の文字列要素）に設定できます。global が指定された場合: 1）データソース実装によって、宛先データセットの適切なリージョンでデータがステージングされるものと想定されます。2）データソースデベロッパーは、global リージョンをサポートした場合の影響（ネットワークトラフィックのレイテンシやリージョン間トラフィックに関連して発生する可能性のある料金など）に注意する必要があります。

メソッド
`create`	データソース定義を作成します。
`delete`	データソース定義を削除します。データソース定義を削除するには、すべてのリージョンのユーザーが、このデータソース定義に関連付けられているすべての転送構成（存在する場合）を削除する必要があります。
`get`	既存のデータソース定義を取得します。
`list`	サポートされているデータソース定義を一覧表示します。
`patch`	既存のデータソース定義を更新します。

REST リソース: projects.locations.dataSourceDefinitions

リソース: DataSourceDefinition

メソッド

`create`

`delete`

`get`

`list`

`patch`