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

BatchApexErrorEvent

Apex の一括処理クラスの実行中に発生したエラーおよび例外について登録者に通知します。このオブジェクトは API バージョン 44.0 以降で使用できます。

Apex 一括処理クラスは、エラーまたは例外が発生したときにプラットフォームイベントを起動できるようになりました。イベントチャネルをリスンしているクライアントは、その失敗頻度、失敗時に範囲内にあったレコード、その他の例外の詳細を判断できます。

サポートされているコール

describeSObjects()

サポートされている登録者

登録者	サポートされているかどうか。
Apex トリガ
フロー
プロセス
ストリーミング API (CometD)

ストリーミング API 登録チャネル

/event/BatchApexErrorEvent

特別なアクセスルール

Salesforce Platform のみがこのイベントを起動でき、Apex コードまたは API では起動できません。「アプリケーションのカスタマイズ」権限を持つユーザには参照アクセス権があります。

項目

項目名	詳細
AsyncApexJobId	型 string プロパティ Nillable 説明このイベントを起動した Apex 一括処理ジョブの AsyncApexJob レコード。
DoesExceedJobScopeMaxLength	型 boolean プロパティ Defaulted on create 説明メッセージが文字数制限を超えているために JobScope 項目が切り捨てられている場合は True。
EventUuid	型 string プロパティ Nillable 説明プラットフォームイベントメッセージを識別するユニバーサル一意識別子 (UUID)。この項目は、API バージョン 52.0 以降で使用できます。
ExceptionType	型 string プロパティ Nillable 説明 Apex 例外種別名。内部プラットフォームエラーは `System.UnexpectedException` 種別として表されます。
JobScope	型 textarea プロパティ Nillable 説明イベントが一括処理ジョブの `execute()` メソッドから起動された場合、範囲内にあったレコード ID。一括処理ジョブで sObject の代わりにカスタムイテレータを使用する場合、JobScope は iterable オブジェクトの `toString()` 表現になります。最大 40000 文字です。
Message	型 string プロパティ Nillable 説明例外メッセージテキスト。最�� 5000 文字です。
Phase	型 string プロパティ Nillable 説明エラーが発生したときの一括処理ジョブのフェーズ。使用可能な値 START EXECUTE FINISH
ReplayId	型 string プロパティ Nillable 説明システムによって生成された ID 値を表し、イベントストリーム内のイベントの位置を参照します。連続するイベントに対して再生 ID の値に連番が振られるという保証はありません。登録者は再生 ID の値を保存し、再登録時にその値を使用して、保持ウィンドウ内の欠落したイベントを取得できます。
RequestId	型 string プロパティ Nillable 説明このイベントを起動した一括処理ジョブの一意の ID。イベント監視のお客様はこの情報を使用してエラーをログ情報と相関することができます。
StackTrace	型 string プロパティ Nillable 説明例外の Apex スタックトレース (利用可能な場合)。最大 5000 文字です。

使用方法

BatchApexErrorEvent メッセージは、Database.RaisesPlatformEvents インターフェースを実装する Apex 一括処理ジョブにより生成され、処理中に発生した未対応の Apex 例外を含みます。詳細は、『Apex 開発者ガイド』を参照してください。

プラットフォームイベント開発者ガイド