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

BatchApexErrorEvent (ベータ)

Apex の一括処理クラスに関連付けられた標準プラットフォームイベントを表します。このオブジェクトは、API バージョン 44.0 以降で使用できます。

Apex 一括処理エラーイベントはベータ機能としてのプレビュー版であり、Salesforce とのマスターサブスクリプション契約における「サービス」には含まれません。この機能はお客様各自の裁量で使用し、購入するときは、現在正式にリリースされている製品および機能に基づいて判断してください。Salesforce はこの機能の特定期間内の正式リリースまたはリリースの有無を保証せず、いつでも中止できます。この機能は評価のみを目的とし、本番環境での使用はできません。この機能は現状のまま提供され、サポートの対象外です。この機能に起因あるいは関連して生じた危害または損害に対して Salesforce は一切の責任を負わないものとします。制限、Salesforce の権利の留保、サービスに関するお客様の義務、関連する Salesforce 以外のアプリケーションおよびコンテンツの使用規約はすべて、お客様によるこの機能の使用にも同様に適用されます。

メモ

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

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

describeSObjects()

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

Apex トリガ プロセス フロー ストリーミング API (CometD)
はい 可 Yes Yes

特別なアクセスルール

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

項目

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

使用方法

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