メタデータ API 開発者ガイド
jPlatformEventSubscriberConfig
ファイルのサフィックスおよびディレクトリの場所
PlatformEventSubscriberConfig コンポーネントのサフィックスは .platformEventSubscriberConfig で、PlatformEventSubscriberConfigs フォルダーに保存されます。
バージョン
PlatformEventSubscriberConfig コンポーネントは、API バージョン 51.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| batchSize | int | プラットフォームイベント Apex トリガーのカスタムバッチサイズ (1 ～ 2,000)。バッチサイズは 1 回の実行でトリガーに送信できるイベントメッセージの最大数に対応します。デフォルトのバッチサイズはプラントイベントトリガーで 2,000 です。 一度に 1 つのイベントを処理するために、バッチサイズを 1 に設定することはお勧めしません。バッチサイズが小さいと、イベントメッセージの処理速度が遅くなることがあります。 |
| isProtected | boolean | (継承された項目)。このコンポーネントが保護されるか (true)、否か (false) を示します。保護コンポーネントは、登録者の組織で作成されたコンポーネントからリンク付けしたり参照したりすることはできません。開発者は、今後のリリースで、インストールの失敗を心配することなく保護コンポーネントを削除できます。ただし、コンポーネントが非保護に設定され、グローバルにリリースされると、開発者は削除できなくなります。 |
| masterLabel | string | 必須。PlatformEventSubscriberConfig コンポーネントの表示ラベル。 |
| platformEventConsumer | string | 必須。設定するプラットフォームイベント Apex トリガーの完全名。 |
| user | string | プラットフォームイベント Apex トリガーを実行するユーザーのユーザー名。デフォルトでは、プラットフォームイベントトリガーは自動化プロセスエンティティとして実行されます。実行ユーザーを特定のユーザーに設定することには、次のような利点があります。
|
宣言的なメタデータの定義のサンプル
この PlatformEventSubscriberConfig コンポーネントの表示ラベルは OrderEventTriggerConfig です。プラットフォームイベントトリガー OrderEventTrigger の設定が含まれ、バッチサイズとユーザーが指定されます。
1<?xml version="1.0" encoding="UTF-8"?>
2<PlatformEventSubscriberConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3 <platformEventConsumer>OrderEventTrigger</platformEventConsumer>
4 <batchSize>200</batchSize>
5 <masterLabel>OrderEventTriggerConfig</masterLabel>
6 <user>user@example.com</user>
7 <isProtected>false</isProtected>
8</PlatformEventSubscriberConfig>PlatformEventSubscriberConfig は Apex トリガーを参照し、このトリガーはプラットフォームイベントに依存しています。参照される項目が Salesforce 組織に存在する場合、PlatformEventSubscriberConfig コンポーネントをリリースできます。この package.xml では、PlatformEventSubscriberConfig コンポーネントを指定します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <name>PlatformEventSubscriberConfig</name>
5 <members>OrderEventTriggerConfig</members>
6 </types>
7 <version>60.0</version>
8</Package>参照されるトリガーおよびプラットフォームイベントが組織に存在しない場合は、パッケージに定義を含めてください。含めなかった場合、リリースは失敗します。この package.xml の例には、参照されるすべてのコンポーネントが含まれています。
- CustomObject はプラットフォームイベントを表しています。
- CustomField はプラットフォームイベントで定義されているカスタム項目を表しています。
- ApexTrigger はプラットフォームイベントトリガーを表しています。
- PlatformEventSubscriberConfig はプラットフォームイベントトリガーの設定オプションを表しています。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <name>CustomObject</name>
5 <members>PlatformEvent__e</members>
6 </types>
7 <types>
8 <name>CustomField</name>
9 <members>PlatformEvent__e.Message__c</members>
10 </types>
11 <types>
12 <name>ApexTrigger</name>
13 <members>OrderEventTrigger</members>
14 </types>
15 <types>
16 <name>PlatformEventSubscriberConfig</name>
17 <members>OrderEventTriggerConfig</members>
18 </types>
19 <version>60.0</version>
20</Package>すべての PlatformEventSubscriberConfig コンポーネントを指定するには、次の例で示しているようにワイルドカード文字を使用します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <name>PlatformEventSubscriberConfig</name>
5 <members>*</members>
6 </types>
7 <version>60.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。