REST リソース: projects.transferConfigs

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

リソース: TransferConfig

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

JSON 表現

JSON 表現
{ "name": string, "destinationDatasetId": string, "displayName": string, "dataSourceId": string, "params": { object }, "schedule": string, "dataRefreshWindowDays": number, "disabled": boolean, "updateTime": string, "nextRunTime": string, "state": enum(`TransferState`), "userId": string, "datasetRegion": string, "partnerToken": string, "partnerConnectionInfo": { object } }


{
  "name": string,
  "destinationDatasetId": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "dataRefreshWindowDays": number,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum(TransferState),
  "userId": string,
  "datasetRegion": string,
  "partnerToken": string,
  "partnerConnectionInfo": {
    object
  }
}

フィールド
`name`	`string` 転送構成のリソース名。転送構成名の形式は `projects/{projectId}/locations/{region}/transferConfigs/{configId}` です。名前は、CreateTransferConfigRequest に指定された configId、projectId、リージョンに基づいて自動的に生成されます。configId が指定されていない場合、通常は configId に uuid が生成されます。ただし uuid は生成されない場合や不要な場合もあります。
`destinationDatasetId`	`string` BigQuery ターゲットデータセット ID。
`displayName`	`string` データ転送にユーザーが指定した表示名。
`dataSourceId`	`string` データソース ID。データ転送の作成後は変更できません。
`params`	`object (Struct format)` データ転送固有のパラメータ。
`schedule`	`string` データ転送スケジュール。データソースでカスタムスケジュールがサポートされていない場合には、空にします。空の場合、データソースのデフォルト値が使用されます。時刻は UTC で指定します。有効な形式の例: `1st,3rd monday of month 15:30`、`every wed,fri of jan,jun 13:15`、`first sunday of quarter 00:00`。形式の詳細については、https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format をご覧ください。注: 単位を 8 時間以上にするか、頻度を下げる必要があります。
`dataRefreshWindowDays`	`number` 自動的に更新するデータの日数。たとえば、`dataRefreshWindowDays = 10` の場合、BigQuery は毎日、[today-1] のデータのみを取り込むのではなく、[today-10, today-1] のデータを再度取り込みます。データソースがこの機能をサポートしている場合にのみ有効です。デフォルト値を使用する場合には、値を 0 に設定します。
`disabled`	`boolean` この構成を無効にします。true に設定すると、指定した転送実行がスケジュールされません。
`updateTime`	`string (Timestamp format)` 出力のみ。データ転送の変更時間。サーバーの入力では無視されます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: `"2014-10-02T15:01:23.045123456Z"`。
`nextRunTime`	`string (Timestamp format)` 出力のみ。データ転送の次の実行時間。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: `"2014-10-02T15:01:23.045123456Z"`。
`state`	`enum(TransferState)` 出力のみ。最後に更新された転送実行の状態。
`userId`	`string (int64 format)` 非推奨。転送が代行されたユーザーの一意の ID。
`datasetRegion`	`string` 出力のみ。BigQuery データセットが配置されたリージョン。
`partnerToken`	`string` 外部パートナー側に保存されている転送設定の識別に使用される一意の識別子。トークンは DTS から見えず、パートナーのみが解釈できます。パートナーデータソースでは、転送構成（実行）の正当性を検証するため、構成 ID とトークンのマッピングが作成されます。
`partnerConnectionInfo`	`object (Struct format)` パートナーデータソースで管理される転送設定。これは Key-Value ペアとして保存され、DTS UI の表示目的にのみ使用されます。接続情報はパートナーにより提供されたものであり、不変パラメータとは異なる DTS UI で編集できません。このため、params とは一緒に保存しません。また、区別するために DataSourceParameter に別のブール値を追加すると、混乱が生じます。- 接続情報には任意の Key-Value ペアを使用できます。これらの params フィールドに追加するには、データソースの定義で定義する必要があります。パートナーにとっては、こうしたことを避けるほうがわかりやすくなります。

メソッド
`create`	新しいデータ転送の構成を作成します。
`delete`	データ転送の構成を削除します。関連する転送実行とログも削除されます。
`get`	データ転送の構成に関する情報を返します。
`list`	プロジェクトのすべてのデータ転送に関する情報を返します。
`patch`	データ転送の構成を更新します。
`scheduleRuns`	時間範囲 [start_time, end_time] の転送実行を作成します。

REST リソース: projects.transferConfigs

リソース: TransferConfig

メソッド

`create`

`delete`

`get`

`list`

`patch`

`scheduleRuns`