リソース: TransferConfig
データ転送の設定を表します。転送構成には、データ転送に必要なすべてのメタデータが含まれます。たとえば、destinationDatasetId
はデータの保存場所を表します。新しい転送構成を作成すると、指定された destinationDatasetId
が必要に応じて作成され、該当するデータソースのサービス アカウントと共有されます。
JSON 表現 | |
---|---|
{ "name": string, "displayName": string, "dataSourceId": string, "params": { object }, "schedule": string, "scheduleOptions": { object ( |
フィールド | |
---|---|
name |
転送構成のリソース名。転送構成名の形式は |
displayName |
データ転送にユーザーが指定した表示名。 |
dataSourceId |
データソースの ID。データ転送の作成後は変更できません。 |
params |
データ転送固有のパラメータ。 |
schedule |
データ転送スケジュール。データソースでカスタム スケジュールがサポートされていない場合には、空にします。空の場合、データソースのデフォルト値が使用されます。時刻は UTC で指定します。有効な形式の例: |
scheduleOptions |
データ転送スケジュールをカスタマイズするオプション。 |
dataRefreshWindowDays |
自動的に更新するデータの日数。たとえば、 |
disabled |
この構成を無効にします。true に設定すると、指定した転送実行がスケジュールされません。 |
updateTime |
出力のみ。データ転送の変更時間。サーバーの入力では無視されます。 |
nextRunTime |
出力のみ。データ転送の次の実行時間。 |
state |
出力のみ。最後に更新された転送実行の状態。 |
userId |
非推奨。転送が代行されたユーザーの一意の ID。 |
datasetRegion |
出力のみ。BigQuery データセットが配置されたリージョン。 |
notificationPubsubTopic |
この転送構成に関連付けられた転送実行が完了した後に通知を送信する Pub/Sub トピック。 |
emailPreferences |
これらの設定により、この転送構成を所有しているユーザーのメールアドレスに通知が送信されます。 |
destinationDatasetId |
BigQuery ターゲット データセット ID。 |
メソッド |
|
---|---|
|
新しいデータ転送の構成を作成します。 |
|
データ転送の構成を削除します。関連する転送実行とログも削除されます。 |
|
データ転送の構成に関する情報を返します。 |
|
プロジェクトのすべてのデータ転送に関する情報を返します。 |
|
データ転送の構成を更新します。 |
(deprecated) |
時間範囲 [start_time, end_time] の転送実行を作成します。 |
|
schedule_time を現在時刻に設定し、手動転送実行をすぐに開始します。 |