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

EventRelayConfig

プラットフォームイベントと変更データキャプチャイベントを Salesforce から Amazon EventBridge にリレーする、イベントリレーの設��を表します。このオブジェクトは、API バージョン 56.0 以降で使用できます。

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

describeSObjects(), query(), retrieve()

特別なアクセスルール

  • このオブジェクトを取得または照会するには、「設定・定義を参照する」権限が割り当てられている必要があります。
  • このオブジェクトは参照のみです。イベントリレーを設定するには、Tooling API では EventRelayConfig、Metadata API では EventRelayConfig を使用します。

項目

項目 詳細
DestinationResourceName
string
プロパティ
Filter、Group、Sort
説明
AWS アカウント情報を保存する指定ログイン情報の API 参照名。destinationResourceName 値には callout: プレフィックスが含まれます。例: callout:MyRelayNamedCredential
DeveloperName
string
プロパティ
Filter、Group、Sort
説明
必須。API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更はサブスクライバーの組織で反映されます。表示ラベルは [レコードタイプ名] です。この項目は自動的に生成されますが、API を使用してレコードを作成する場合は独自の値を指定できます。
EventChannel
picklist
プロパティ
Filter、Group、Restricted picklist、Sort
説明
イベントリレーで使用されるイベントチャネルの完全名。例: MyRelayChannel__chn
Language
picklist
プロパティ
Filter、Group、Restricted picklist、Sort
説明
EventRelayConfig の言語。
可能な値は次のとおりです。
  • da — デンマーク語
  • de — ドイツ語
  • en_US — 英語
  • es — スペイン語
  • es_MX — スペイン語 (メキシコ)
  • fi — フィンランド語
  • fr — フランス語
  • it — イタリア語
  • ja — 日本語
  • ko — 韓国語
  • nl_NL — オランダ語
  • no — ノルウェー語
  • pt_BR — ポルトガル語 (ブラジル)
  • ru — ロシア語
  • sv — スウェーデン語
  • th — タイ語
  • zh_CN — 中国語 (簡体字)
  • zh_TW — 中国語 (繁体字)
MasterLabel
string
プロパティ
Filter、Group、Sort
説明
EventRelayConfig の表示ラベル。UI では、この項目は [イベントリレー設定] です。
NamespacePrefix
string
プロパティ
Filter、Group、Nillable、Sort
説明
このオブジェクトと関連付けられた名前空間プレフィックス。管理パッケージを作成する Developer Edition 組織には、一意の名前空間プレフィックスがあります。制限: 15 文字。namespacePrefix__componentName 表記を使用して、管理パッケージのコンポーネントを参照できます。

名前空間プレフィックスには、次のいずれかの値があります。

  • Developer Edition 組織では、名前空間プレフィックスは、サポートしているすべてのオブジェクトに組織の名前空間プレフィックスを設定します。オブジェクトがインストールされた管理パッケージ内にある場合には例外があります。その場合、オブジェクトにはインストールされた管理パッケージの名前空間プレフィックスが付きます。この項目の値は、パッケージ開発者の Developer Edition 組織の名前空間プレフィックスです。
  • Developer Edition 組織でない場合、NamespacePrefix は、インストールされた管理パッケージの一部であるオブジェクトに設定されます。その他すべてのオブジェクトには名前空間プレフィックスはありません。
RelayOption
textarea
プロパティ
Nillable
説明
システムがエラーから回復した後、イベントリレーを再開するためのオプションを含む JSON 符号化された文字列。このオプションは、最後にリレーされたイベントの後に、イベントリレーを再開できない場合に使用されます。使用可能な選択肢は次のとおりです。
  • "{\"ReplayRecovery\":\"LATEST\"}" — (デフォルト) イベントバスで受信した新しいイベントからイベントのリレーを開始します。リレーの停止中に欠落したイベントを必要としない場合は、このオプションを使用します。
  • "{\"ReplayRecovery\":\"EARLIEST\"}" — イベントバスに保存されているすべてのイベントを再送信し、それ以降は新しいイベントをリレーします。イベントバスにはイベントが最大 3 日間保存されます。保存されているすべてのイベントを再処理して、欠落したイベントを確認する場合は、このオプションを使用します。
State
picklist
プロパティ
Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
イベントリレーの実行状況。可能な値は次のとおりです。
  • RUN — イベントリレーが実行され、イベントメッセージが Salesforce から Amazon EventBridge に正常にリレーされています。
  • PAUSE — システム管理者がイベントリレーを一時停止しました。この状況の間は、イベントは Amazon EventBridge にリレーされません。現在の状況に関する情報はすべて保存されます。
  • STOP — (デフォルト) イベントリレーが停止され、イベントは Amazon EventBridge にリレーされません。現在の状況に関する情報は削除されます。
UsageType
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明
将来の使用のために予約されています。