コレクション: projects.transferConfigs

リソース: TransferConfig

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

JSON 表現

{
  "name": string,
  "destinationDatasetId": string,
  "displayName": string,
  "updateTime": string,
  "dataSourceId": string,
  "schedule": string,
  "nextRunTime": string,
  "params": {
    object
  },
  "status": enum(TransferStatus),
  "userId": string,
  "dataRefreshWindowDays": number,
  "disabled": boolean,
}
フィールド
name

string

転送実行のリソース名。転送実行の名前は projects/{projectId}/transferConfigs/{config_id} という形式になります。config_id は通常 uuid です。生成されない場合や不要な場合もあります。転送実行を作成する場合、この名前は無視されます。

destinationDatasetId

string

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

displayName

string

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

updateTime

string (Timestamp 形式)

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

RFC3339 UTC 「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

注: このフィールドはレスポンスのみで使用されます。リクエストでここで指定された値は、すべて無視されます。

dataSourceId

string

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

schedule

string

GROC 形式のデータ転送スケジュール。データソースでカスタム スケジュールがサポートされていない場合には、空にします。空の場合、データソースのデフォルト値が使用されます。時間は UTC で指定します。有効な GROC の例: 1st,3rd monday of month 15:30every wed,fri of jan,jun 13:15first sunday of quarter 00:00

nextRunTime

string (Timestamp 形式)

データ転送の次の実行時間。出力のみ。バッチデータの転送でのみ使用します。

RFC3339 UTC 「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

注: このフィールドはレスポンスのみで使用されます。リクエストでここで指定された値は、すべて無視されます。

params

object (Struct 形式)

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

status

enum(TransferStatus)

最後に更新された転送実行のステータス

注: このフィールドはレスポンスのみで使用されます。リクエストでここで指定された値は、すべて無視されます。

userId

string (int64 format)

転送が代行されたユーザーの GaiaID。サービス アカウントをサポートしないデータソースにのみ適用されます。0 に設定すると、データソースのサービス アカウントの認証情報が使用されます。

注: このフィールドはレスポンスのみで使用されます。リクエストでここで指定された値は、すべて無視されます。

dataRefreshWindowDays

number

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

disabled

boolean

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

メソッド

create

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

delete

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

get

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

list

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

scheduleRuns

時間範囲 [range_start_time, range_end_time] 内の転送実行を作成します。

update

データ転送の設定を更新します。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...