BatchJob

非同期で処理されるミューテーションのリスト。ミューテーションはユーザーがアップロードします。ミューテーション自体は読み取ることができないため、ジョブの結果は BatchJobService.ListBatchJobResults を使用してのみ読み取ることができます。

JSON 表現 
{
  "resourceName": string,
  "metadata": {
    object (BatchJobMetadata)
  },
  "status": enum (BatchJobStatus),
  "id": string,
  "nextAddSequenceToken": string,
  "longRunningOperation": string
}
フィールド
resourceName

string

変更不可。バッチジョブのリソース名。バッチジョブのリソース名の形式は次のとおりです。

customers/{customerId}/batchJobs/{batch_job_id}
metadata

object (BatchJobMetadata)

出力のみ。このバッチジョブに関する追加情報が含まれます。
status

enum (BatchJobStatus)

出力のみ。このバッチジョブのステータス。
id

string (int64 format)

出力のみ。このバッチジョブの ID。
nextAddSequenceToken

string

出力のみ。オペレーションの追加時に使用する次のシーケンス トークン。バッチジョブのステータスが PENDING の場合にのみ設定されます。
longRunningOperation

string

出力のみ。完了をポーリングするために使用できる長時間実行オペレーションのリソース名。バッチジョブのステータスが「RUNNING」または「DONE」の場合にのみ設定されます。

BatchJobMetadata

バッチジョブに関する追加情報。このメッセージは、バッチジョブの長時間実行オペレーションで返されるメタデータとしても使用されます。

JSON 表現 
{
  "creationDateTime": string,
  "startDateTime": string,
  "completionDateTime": string,
  "estimatedCompletionRatio": number,
  "operationCount": string,
  "executedOperationCount": string,
  "executionLimitSeconds": integer
}
フィールド
creationDateTime

string

出力のみ。このバッチジョブが作成された時刻。形式は yyyy-mm-dd hh:mm:ss です。例: 「2018-03-05 09:15:00」
startDateTime

string

出力のみ。このバッチジョブの実行が開始された時刻。形式は yyyy-mm-dd hh:mm:ss です。例: 「2018-03-05 09:15:30」
completionDateTime

string

出力のみ。このバッチジョブが完了した時刻。形式は yyyy-MM-dd HH:mm:ss です。例: 「2018-03-05 09:16:00」
estimatedCompletionRatio

number

出力のみ。処理された変異の割合（0.0 ～ 1.0）。ジョブがまだ実行されていない場合は空になります。
operationCount

string (int64 format)

出力のみ。バッチジョブ内の変換オペレーションの数。
executedOperationCount

string (int64 format)

出力のみ。バッチジョブによって実行された変換オペレーションの数。ジョブの実行が開始された場合にのみ存在します。
executionLimitSeconds

integer

変更不可。バッチジョブを実行できる時間のおおよその上限（秒単位）。ジョブの実行が指定された上限を超えた場合、ジョブはキャンセルされます。

BatchJobStatus

バッチジョブのステータス。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
PENDING ジョブは現在実行されていません。
RUNNING ジョブは実行中です。
DONE これで完了です。