REST リソース: projects.locations.transferConfigs

リソース: TransferConfig

データ転送の設定を表します。転送構成には、データ転送に必要なすべてのメタデータが含まれます。たとえば、destinationDatasetId はデータの保存場所を表します。新しい転送構成を作成すると、指定された destinationDatasetId が必要に応じて作成され、該当するデータソースのサービス アカウントと共有されます。

JSON 表現

{
  "name": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "scheduleOptions": {
    object (ScheduleOptions)
  },
  "dataRefreshWindowDays": integer,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum (TransferState),
  "userId": string,
  "datasetRegion": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
フィールド
name

string

転送構成のリソース名。転送構成名の形式は projects/{projectId}/locations/{region}/transferConfigs/{configId} です。名前は、CreateTransferConfigRequest に指定された configId、projectId、リージョンに基づいて自動的に生成されます。configId が指定されていない場合、通常は configId に uuid が生成されます。ただし uuid は生成されない場合や不要な場合もあります。

displayName

string

データ転送にユーザーが指定した表示名。

dataSourceId

string

データソース ID。データ転送の作成後は変更できません。

params

object (Struct format)

データ転送固有のパラメータ。

schedule

string

データ転送スケジュール。データソースでカスタム スケジュールがサポートされていない場合には、空にします。空の場合、データソースのデフォルト値が使用されます。時刻は UTC で指定します。有効な形式の例: 1st,3rd monday of month 15:30every wed,fri of jan,jun 13:15first sunday of quarter 00:00。形式の詳細については、https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format をご覧ください。注: 単位を 8 時間以上にするか、頻度を下げる必要があります。

scheduleOptions

object (ScheduleOptions)

データ転送スケジュールをカスタマイズするオプション。

dataRefreshWindowDays

integer

自動的に更新するデータの日数。たとえば、dataRefreshWindowDays = 10 の場合、BigQuery は毎日、[today-1] のデータのみを取り込むのではなく、[today-10, today-1] のデータを再度取り込みます。データソースがこの機能をサポートしている場合にのみ有効です。デフォルト値を使用する場合には、値を 0 に設定します。

disabled

boolean

この構成を無効にします。true に設定すると、指定した転送実行がスケジュールされません。

updateTime

string (Timestamp format)

出力のみ。データ転送の変更時間。サーバーの入力では無視されます。

nextRunTime

string (Timestamp format)

出力のみ。データ転送の次の実行時間。

state

enum (TransferState)

出力のみ。最後に更新された転送実行の状態。

userId

string (int64 format)

非推奨。転送が代行されたユーザーの一意の ID。

datasetRegion

string

出力のみ。BigQuery データセットが配置されたリージョン。

notificationPubsubTopic

string

この転送構成に関連付けられた転送実行が完了した後に通知を送信する Pub/Sub トピック。

emailPreferences

object (EmailPreferences)

これらの設定により、この転送構成を所有しているユーザーのメールアドレスに通知が送信されます。

destinationDatasetId

string

BigQuery ターゲット データセット ID。

ScheduleOptions

データ転送スケジュールをカスタマイズするオプション。

JSON 表現

{
  "disableAutoScheduling": boolean,
  "startTime": string,
  "endTime": string
}
フィールド
disableAutoScheduling

boolean

true の場合、この構成のデータ転送の自動スケジュールは無効になります。transferConfigs.startManualRuns API を使用して、実行をアドホック ベース開始できます。自動スケジュールが無効になっている場合、TransferConfig.schedule フィールドは無視されます。

startTime

string (Timestamp format)

転送実行のスケジュールを開始する時間を指定します。最初の実行は、スケジュール文字列に定義された繰り返しパターンに従って開始時間またはそれ以降にスケジュールされます。開始時間はいつでも変更できます。このオプションでは、手動でデータ転送が開始されるまでの時間は制限されません。

endTime

string (Timestamp format)

転送実行のスケジュールを停止する時間を定義します。転送実行は、終了時間またはそれ以降にスケジュールできません。終了時間はいつでも変更できます。このオプションでは、手動でデータ転送が開始されるまでの時間は制限されません。

メソッド

create

新しいデータ転送の構成を作成します。

delete

データ転送の構成を削除します。関連する転送実行とログも削除されます。

get

データ転送の構成に関する情報を返します。

list

プロジェクトのすべてのデータ転送に関する情報を返します。

patch

データ転送の構成を更新します。

scheduleRuns
(deprecated)

時間範囲 [start_time, end_time] の転送実行を作成します。

startManualRuns

schedule_time を現在時刻に設定し、手動転送実行をすぐに開始します。