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

ManagedEventSubscription (ベータ)

Pub/Sub API の管理されたイベント登録を表します。登録者クライアントがコンシュームしたイベントを追跡し、中断したところから登録を再開するには、管理されたイベント登録を使用します。メタデータ型を拡張し、その fullName 項目を継承します。

この機能はベータサービスです。ベータサービスはお客様ご自身の裁量でお試しいただくものです。ベータ機能の使用には、「Agreements and Terms」に記載されたベータサービス規約が適用されます。

メモ

ファイルのサフィックスおよびディレクトリの場所

ManagedEventSubscription コンポーネントのサフィックスは .managedEventSubscription で、managedEventSubscriptions フォルダーに保存されます。

バージョン

ManagedEventSubscription コンポーネントは、API バージョン 60.0 以降で使用できます。

特別なアクセスルール

この型をリリースおよび取得するには、「アプリケーションのカスタマイズ」権限が必要です。

項目

項目名	項目の型	説明
defaultReplay	EventSubscriptionReplayPreset (string 型の列挙)	クライアントが初めて登録を開始したとき、またはクライアントが再実行 ID をコミットしていないときに、登録が開始するストリーム内の位置。可能な値は次のとおりです。 `LATEST (最新)` - (デフォルト) 登録は、受信した最新のイベントから開始します。このオプションでは、クライアントが切断されたときに公開されたイベントの送信はスキップされます。 `EARLIEST (最早)` - 登録は、イベントバスに保存された最も古いイベントから開始します。このオプションでは、新しいイベントと、経過時間が 72 時間未満のその他のイベントが送信されます。保存されているすべてのイベントを再処理して、欠落したイベントを取り戻すことができます。このオプションは慎重に使用してください。大量のイベントメッセージが保存されているときに `EARLIEST (最早)` オプションで登録すると、パフォーマンスが低下し、イベント配信割り当てを使い果たす可能性があります。
errorRecoveryReplay	EventSubscriptionReplayPreset (string 型の列挙)	コミットされた再実行 ID が無効な場合に、登録が再開されるストリーム内の位置。再実行 ID は、イベント保持期間より古いと無効になることがあります。可能な値は次のとおりです。 `LATEST` (最新) - (デフォルト) 登録は、受信した最新のイベントから再開します。このオプションでは、クライアントが切断されたときに公開されたイベントの送信はスキップされます。 `EARLIEST` (最早) - 登録は、イベントバスに保存された最も古いイベントから再開します。このオプションでは、新しいイベントと、経過時間が 72 時間未満のその他のイベントが送信されます。保存されているすべてのイベントを再処理して、欠落したイベントを取り戻すことができます。このオプションは慎重に使用してください。大量のイベントメッセージが保存されているときに `EARLIEST (最早)` オプションで登録すると、パフォーマンスが低下し、イベント配信割り当てを使い果たす可能性があります。
label	string	管理された登録のラベル。
state	EventSubscriptionAdminState (string 型の列挙)	`ManagedSubscribe` RPC 呼び出しがコンシュームする実行状況。state が `RUN` (実行) に設定されている場合、登録は `ManagedSubscribe` RPC 呼び出しが行われたときに開始されます。それ以外の場合は、登録は開始されません。管理者が後で state を `RUN` (実行) から `STOP` (停止) に変更した場合、システムは Pub/Sub API クライアントに新しい state 値を通知し、登録は切断されます。また、以前にコミットされた再実行 ID の保存値も削除されます。state が `STOP` (停止) から `RUN` (実行) に変更された後、次に `ManagedSubscribe` RPC 呼び出しが行われると、登録は defaultReplay 値から開始されます。 state で使用できる値は次のとおりです。 `RUN` - (デフォルト) 登録は実行中であり、Pub/Sub API クライアントに新しいイベントを配信します。 `STOP` - 登録は停止されています。この状態の間、Pub/Sub API クライアントにイベントは配信されず、以前にコミットされた再実行 ID は削除されます。 `PAUSE` - 内部使用のために予約されています。
topicName	string	プラットフォームイベントや変更イベントのトピック名、またはカスタムプラットフォームイベントチャネルやカスタムまたは標準の変更データキャプチャチャネルのチャネル名。トピック名は、次の値のいずれかになります。プラットフォームイベント - `/event/EventName__e` カスタムプラットフォームイベントチャネル - `/event/CustomPEChannel__chn` 標準変更イベント - `/data/ChangeEvents` 変更イベント (「`Object`」をオブジェクト名で置き換える) - `/data/ObjectChangeEvent`.たとえば、「Account」の場合 `/data/AccountChangeEvent` になります。カスタム変更イベントチャネル - `/data/CustomChangeChannel__chn`
version	string	内部使用のために予約されています。

宣言的なメタデータの定義のサンプル

ファイル名 My_Managed_Subscription.managedSubscription を持つ ManagedEventSubscription コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ManagedEventSubscription xmlns="http://soap.sforce.com/2006/04/metadata">
3    <defaultReplay>LATEST</defaultReplay>
4    <errorRecoveryReplay>LATEST</errorRecoveryReplay>
5    <label>My Managed Subscription</label>
6    <state>RUN</state>
7    <topicName>/event/Order_Event__e</topicName>
8</ManagedEventSubscription>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>My_Managed_Subscription</members>
5        <name>ManagedEventSubscription</name>
6    </types>
7    <version>60.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド