Apex によるイベントメッセージの公開

Apex でのイベントの作成

イベントメッセージを公開する前に、プラットフォームイベントインスタンスを作成します。

イベント API 参照名を使用したイベントの作成:

Salesforce またはカスタムオブジェクトインスタンスを作成するのと同じ方法でイベントインスタンスを作成します。new 演算子とイベント API 参照名を使用します。

EventUuid 項目が事前に入力されたイベントの作成:

標準の EventUuid 項目をイベント変数に事前に入力する場合は、Apex sobjectType.newSobject メソッドを使用してイベントを作成します。

EventUuid 項目には、イベントメッセージを識別するユニバーサル一意識別子 (UUID) が保持されます。EventUuid 項目を使用して、イベントメッセージの配信を追跡できます。詳細は、「Apex 公開コールバックを使用した非同期プラットフォームイベント公開の結果の取得」を参照してください。

イベントメッセージを公開するには、EventBus.publish メソッドをコールします。たとえば、[Low Ink (低インクレベル)] というカスタムプラットフォームイベントを定義している場合は、そのイベント種別を Low_Ink__e として参照します。次に、このイベントのインスタンスを作成して Apex メソッドに渡します。

Database.SaveResult の即時の公開結果

各イベントの Database.SaveResult には、操作の成功とエラーの発生に関する情報が含まれます。isSuccess() メソッドが true を返した場合、公開要求は Salesforce のキューに入れられ、イベントメッセージが非同期で公開されます。詳細は、「大規模プラットフォームイベントの保持」を参照してください。isSuccess() が false を返す場合、イベント公開操作でエラーが発生しており、エラーは Database.Error オブジェクトに返されています。EventBus.publish() は、渡されたイベントを、エラーで公開できないものを除いて部分的に公開できます。EventBus.publish() メソッドは、失敗した公開操作による例外を発生させません。これは、Apex の Database.insert メソッドが部分的な完了オプションを指定してコールされたときの動作に似ています。

Database.SaveResult には、Id システム項目も含まれます。Id 項目値は、サブスクライバーに配信されるイベントメッセージには含まれません。これは、イベントメッセージの識別に使用されず、必ずしも一意ではありません。

非同期公開で返される状況コード

公開操作が非同期であることを示すため、Database.SaveResult の EventBus.publish コールが成功した場合は、OPERATION_ENQUEUED 状況コードがイベント UUID とともに返されます。状況コードとイベント UUID は、結果の成功を確認した後に取得できます。次の例は、公開コールが成功した後の Database.SaveResult の内容を出力したものです。Database.Error の getStatusCode メソッドは、OPERATION_ENQUEUED の状況コードを返します。getMessage メソッドは、公開されたイベントメッセージのイベント UUID 値を返します。

公開動作

プラットフォームイベントメッセージは、プラットフォームイベント定義で設定した公開動作に応じて、ただちに、またはトランザクションがコミットされた後に公開されます。詳細は、「プラットフォームイベント項目」を参照してください。Apex ガバナ制限が適用されます。[コミット後に公開] 動作で設定されたイベントの場合、各メソッドの実行は、Apex DML ステートメント制限に対して 1 つの DML ステートメントとして計数されます。利用制限は、Apex Limits.getDMLStatements() メソッドを使用して確認できます。[すぐに公開] 動作で設定されたイベントの場合、各メソッドの実行は、150 EventBus.publish() コールの個別のイベント公開制限に対して反映されます。利用制限は、Apex Limits.getPublishImmediateDML() メソッドを使用して確認できます。