REST リソース: projects.locations.transferConfigs.runs

リソース: TransferRun

実行されるデータ転送を表します。

JSON 表現 

{
  "name": string,
  "scheduleTime": string,
  "runTime": string,
  "errorStatus": {
    object (Status)
  },
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "params": {
    object
  },
  "dataSourceId": string,
  "state": enum (TransferState),
  "userId": string,
  "schedule": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
フィールド
name

string

転送実行のリソース名。転送実行名の形式は projects/{projectId}/locations/{location}/transferConfigs/{configId}/runs/{run_id} です。転送実行を作成する場合、この名前は無視されます。
scheduleTime

string (Timestamp format)

転送実行が開始するまでの最小時間。
runTime

string (Timestamp format)

バッチ転送実行の場合、データを取り込む日時を指定します。
errorStatus

object (Status)

転送実行のステータス。
startTime

string (Timestamp format)

出力のみ。転送実行の開始時間。入力リクエストでは、パラメータが無視されます。
endTime

string (Timestamp format)

出力のみ。転送実行の終了時間。入力リクエストでは、パラメータが無視されます。
updateTime

string (Timestamp format)

出力のみ。データ転送実行状態が最後に更新された時間。
params

object (Struct format)

出力のみ。データ転送固有のパラメータ。
dataSourceId

string

出力のみ。データソースの ID。
state

enum (TransferState)

データ転送の実行状態。入力リクエストでは無視されます。
userId

string (int64 format)

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

string

出力のみ。定期的なスケジュールの一部として転送ジョブが作成されている場合には、この転送ジョブのスケジュールが入ります。手動でスケジュールされたバッチ転送実行の場合、このフィールドは空になります。注: 現在の負荷状態に応じて、システムがスケジュールの延期を選択する場合があります。このため、この値と scheduleTime が一致しないことがあります。
notificationPubsubTopic

string

出力のみ。この転送実行の完了後に通知を送信する Pub/Sub トピック
emailPreferences

object (EmailPreferences)

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

string

出力のみ。BigQuery ターゲット データセット ID。

ステータス

Status 型は、REST API や RPC API など、さまざまなプログラミング環境に適した論理エラーモデルを定義します。gRPC により使用されます。各 Status メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。

このエラーモデルと操作方法について詳しくは、API 設計ガイドをご覧ください。

JSON 表現 

{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。
message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。
details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。

任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }。

メソッド

delete

 指定した転送実行を削除します。

get

 特定の転送実行に関する情報を返します。

list

 実行中のジョブと完了したジョブの情報を返します。