この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

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 システム項目 バッチの現在の処理状態。
  • Queued: バッチ処理はまだ開始されていません。このバッチに関連付けられているジョブが中止された場合は、バッチは処理されず、状態は Not Processed に設定されます。
  • InProgress: バッチは処理中です。バッチに関連付けられているジョブが中止された場合でも、バッチは完了するまで処理されます。バッチで処理を完了できるようにするため、バッチに関連付けられているジョブを閉じる必要があります。
  • Completed: バッチ処理は完了済みで、結果のリソースが使用可能です。一部のレコードの処理に失敗した場合は、結果のリソースに示されます。バッチは、一部のレコードまたはすべてのレコードの処理に失敗した場合でも完了します。レコードのサブセットの処理に失敗した場合、正常に処理されたレコードはロールバックされません。
  • Failed: 要求がサポートされない形式に圧縮されている、内部のサーバエラーが発生したなどの予期しないエラーにより、このバッチは要求全体の処理に失敗しました。エラーの詳細は、stateMessage 要素に出力されます。バッチの状態が Failed であっても、一部のレコードは正常に処理されている可能性があります。処理されたレコードの数は numberRecordsProcessed 項目に出力されます。正常に処理されなかったレコードの数は numberRecordsFailed 項目に出力されます。
  • Not Processed: バッチはこれ以降処理されることはありません。この状態は、バッチがキューに入っている間にジョブが中止された場合に適用されます。一括クエリのジョブで PK Chunking が有効になっている場合、後続のバッチが作成されるときに、クエリを含む元のバッチにこの状態が割り当てられます。元のバッチがこの状態に変更された後に、後続のバッチを監視し、各バッチの完了時にその結果を取得できます。その後安全にジョブを終了できます。
stateMessage string システム項目 状態 (state) に関する詳細が出力されます。たとえば、state の値が Failed の場合にはエラーの原因が出力されます。なお、複数のエラーが発生した場合には、最大長を超えたメッセージが切り捨てられることがあります。そのような場合は、確認できたエラーを修正してからバッチを再送信してください。バッチの状態が Failed であっても、一部のレコードは正常に処理されている可能性があります。
systemModstamp dateTime システム項目 UTC タイムゾーンでの処理の終了日時。状態が Completed の場合のみ有効です。
totalProcessingTime Long システム項目 バッチの処理時間 (ミリ秒)。バッチがキューで処理を待機している時間は除外されます。apexProcessingTimeおよびapiActiveProcessingTimeも参照してください。

この項目は、API バージョン 19.0 以降で使用できます。

HTTP の BatchInfoList

名前 説明
batchInfo BatchInfo ジョブに関連付けられた各バッチに関する BatchInfo のリソースの要素。BatchInfo の構成については、「BatchInfo」を参照してください。