BatchInfo
BatchInfo には、Salesforce に送信して処理する 1 件のバッチの情報が格納されます。
BatchInfo
| 名前 | 型 | 要求 | 説明 |
|---|---|---|---|
| apexProcessingTime | Long | システム項目 | バッチデータに関連するトリガおよび他のプロセスの処理時間 (ミリ秒)。トリガがない場合、この値は 0 になります。非同期およびバッチの Apex 操作の処理時間は含まれません。「apiActiveProcessingTime」および「totalProcessingTime」も参照してください。 この項目は、API バージョン 19.0 以降で使用できます。 |
| apiActiveProcessingTime | Long | システム項目 | 有効なバッチの処理時間 (ミリ秒)。apexProcessingTime の時間を含みます。バッチがキューで処理を待機している時間や、逐次化および並列化に要する時間は含まれません。「totalProcessingTime」も参照してください。 この項目は、API バージョン 19.0 以降で使用できます。 |
| createdDate | dateTime | システム項目 | UTC タイムゾーンでのバッチの作成日時。これは処理が開始した時間ではなく、バッチがジョブに追加された時間です。 |
| id | string | 必須 | バッチの ID。グローバルにユニークの場合がありますが、必ずしもそうである必要はありません。 |
| jobId | string | 必須 | バッチに関連付けられたジョブを一意に識別する 18 文字から成る ID。 |
| numberRecordsFailed | int | システム項目 | このバッチで正常に処理されなかったレコードの数。 この項目は、API バージョン 19.0 以降で使用できます。 |
| numberRecordsProcessed | int | システム項目 | 要求が送信された時点で、このバッチで処理済みのレコード数。この数値は、処理されたバッチ数が増えると大きくなります。 |
| state | BatchStateEnum | システム項目 | バッチの現在の処理状態。
|
| stateMessage | string | システム項目 | 状態 (state) に関する詳細が出力されます。たとえば、state の値が Failed の場合にはエラーの原因が出力されます。なお、複数のエラーが発生した場合には、最大長を超えたメッセージが切り捨てられることがあります。そのような場合は、確認できたエラーを修正してからバッチを再送信してください。バッチの状態が Failed であっても、一部のレコードは正常に処理されている可能性があります。 |
| systemModstamp | dateTime | システム項目 | UTC タイムゾーンでの処理の終了日時。状態が Completed の場合のみ有効です。 |
| totalProcessingTime | Long | システム項目 | バッチの処理時間 (ミリ秒)。バッチがキューで処理を待機している時間は除外されます。「apexProcessingTime」および「apiActiveProcessingTime」も参照してください。 この項目は、API バージョン 19.0 以降で使用できます。 |
HTTP の BatchInfoList
| 名前 | 型 | 説明 |
|---|---|---|
| batchInfo | BatchInfo | ジョブに関連付けられた各バッチに関する BatchInfo のリソースの要素。BatchInfo の構成については、「BatchInfo」を参照してください。 |