コンポーネントイベントソースのサンプルペイロード生成

ペイロード生成

コンポーネントイベントリスナーは、Catalystコンポーネントの1つで発生する特定のイベントをリッスンし、関連するターゲットFunctionをトリガーしてコンポーネントデータを渡します。プロジェクトにはデフォルトで作成されています。CLIで、必要なソースとアクションの同じパターンのサンプルデータを取得できます。

CLIでイベントのサンプルペイロードを生成する一般的なコマンドは次のとおりです：

以下の表に示すCatalystコンポーネントイベントのソースと関連するアクションの任意の組み合わせをコマンドに指定できます：

たとえば、Data Store Insertイベントのサンプルペイロードを生成するには、次のコマンドを実行します：

これにより、このソースとアクションの次のJSONペイロードが生成されます。ペイロードには、プロジェクトの実際の詳細、デフォルトのイベントバスの詳細、およびサンプルエンティティの詳細が含まれます。

このデータをFunctionsシェルを通じてEvent Functionに渡し、要件に応じてテストできます。

CLIに表示する代わりに、次のようにJSONペイロードを直接ファイルに保存することもできます：

オプション入力

必須のソースとアクションのペアに加えて、表に示すようにエンティティソースに関するオプション入力を提供することもできます。たとえば、Data Storeのinsert操作のサンプルペイロード生成時にテーブル名またはIDを指定すると、Catalystはリモートプロジェクトでその名前またはIDのテーブルを確認します。エンティティが存在する場合、CLIはJSONペイロードにそのテーブルのデータを表示します。

オプション入力を提供しない場合、または入力に一致するエンティティが見つからない場合、CLIはランダムなサンプルデータでJSONペイロードを生成します。

たとえば、リモートコンソールで設定された既存のセグメントでのcache putイベントのサンプルペイロードを生成するには、次のコマンドを実行します：

Catalystはその名前またはIDのセグメントを確認します。存在する場合、そのセグメントのデータを含むペイロードが生成されます。渡されたSegment IDは、以下の例でsource_entity_idの値として指定されています。

コンポーネントイベント生成オプション

catalyst event:generateコマンドは、一緒に使用できる2つのオプションをサポートしています。ただし、コンポーネントイベントソースのサンプルペイロードを生成する場合、それらのオプションのうち1つのみが適用されます。

-e | --event-bus <event_bus_name>

--event-busまたは-eオプションを使用すると、サンプルペイロードで使用するイベントバスの名前を指定できます。任意のソースまたはアクションのペイロード生成時にこれを使用できます。event_bus_details JSONには、渡された名前がバス名として含まれます。

イベントバス名を指定しない場合、コンポーネントイベントのペイロードではバス名は「Default」になります。

たとえば、cache putイベントのペイロードを生成し、イベントバス名を指定するには、次のコマンドを実行します：

これにより、ペイロードが生成され、event_bus_detailsにイベントバス名が含まれます。

利用可能なオプションについては、次のセクションでカスタムイベントソースのコンテキストで説明します。