Event Functions

はじめに

Event Functionは、Event Listenerに関連付けられた非同期タスクFunctionです。Event Functionは、指定されたイベントの発生時にタスクまたは一連のタスクを実行するために作成されます。

デフォルトのEvent ListenerはCatalystコンポーネントで発生するイベントをリッスンし、カスタムEvent Listenerは特定のURLの呼び出しをリッスンします。これらのイベントが発生すると、そのEvent Listenerインスタンスに関連付けられたEvent Functionが自動的に呼び出されて実行されます。

Event Functionを手動で呼び出したり、コンソールでテストしたりすることはできません。ただし、CLIでfunctions:shellコマンドを使用してテストできます。また、CLIでevent:generateコマンドを使用して、Event Functionのサンプル入力ペイロードを生成してテストすることもできます。Event FunctionのエンドポイントはBasic I/OやAdvanced I/O FunctionsのようなFunction URLを通じてアクセスできません。Event Functionは、Function実行の成功または失敗の判定以外のレスポンスを返しません。

CatalystコンソールからEvent Functionを作成し、そこでコーディングするか、CLIを使用してFunctionを初期化し、コンソールにデプロイできます。

Functions紹介ページで説明されているように、LogsやApplication Performance Monitoringなどのさまざまなツールを使用して、Event Functionsを管理し、パフォーマンス統計を表示できます。

Event Functionsの操作を練習するには、Event FunctionチュートリアルまたはWorkDrive Sync Appチュートリアルを参照してください。

Event Functionモジュール

Java

Catalyst Event Functionは、Javaで2つのモジュールをサポートしています：contextとevent。

contextモジュールには、以下の組み込みメソッドが含まれています：

1. context.getRemainingExecutionTimeMs(): Functionの残りの実行時間を取得するために使用できます。
2. context.getMaxExecutionTimeMs(): このメソッドは、Functionの最大実行時間を取得するために使用でき、15分の定数値です。

eventモジュールには、以下の組み込みメソッドが含まれています：

1. event.getAction(): デフォルトのEvent Listenerでイベントをトリガーしたcatalystコンポーネントで実行されたアクション（テーブルへのデータ挿入やユーザーサインアップなど）を取得します。
2. event.getSourceEntityId(): イベントが発生したソースエンティティのID（テーブルIDやキャッシュのセグメントIDなど）を取得するために使用できます。
3. event.getProjectDetails(): プロジェクトIDやプロジェクト名などのプロジェクト詳細を取得します。
4. event.getData(): Event Functionに関連付けられたイベントのデータを取得します。
5. event.getTime(): Event Functionを呼び出したイベントの発生時間を取得します。
6. event.getSource(): Data Store、Cache、Authentication、File Store、Githubおよびウェブクライアントなど、イベントをトリガーしたソースの名前を取得します。
7. event.getEventBusDetails(): 設定されたイベントアクションやルールなどのイベントバスの詳細を取得します。

Java Functionを実行すると、実行の終了時に実行ステータスがSUCCESSまたはFAILUREとして返されます。返されるステータスはcom.catalyst.event.EVENT_STATUS型です。

Node.js

Catalyst Event Functionは、Node.jsで2つのモジュールをサポートしています：contextとevent。

contextモジュールには、以下の組み込みメソッドが含まれています：

1. context.closeWithSuccess(): Functionが正常に実行されたことを示します。Functionの最後に使用する必要があります。
2. context.closeWithFailure(): Functionの実行が失敗したことを示します。Functionの最後に使用する必要があります。
3. context.getRemainingExecutionTimeMs(): Functionの残りの実行時間を取得するために使用できます。
4. context.getMaxExecutionTimeMs(): このメソッドは、Functionの最大実行時間を取得するために使用でき、15分の定数値です。

eventモジュールには、以下の組み込みメソッドが含まれています：

1. event.getProjectDetails(): プロジェクトIDやプロジェクト名などのプロジェクト詳細を取得します
2. event.getData(): Functionに関連付けられたイベントのデータを取得します
3. event.getTime(): Functionを呼び出したイベントの発生時間を取得します
4. event.getSource(): このメソッドは、DataStore、Cache、Authentication、FileStore、Githubおよびwebclientなど、イベントをトリガーしたソースの名前を取得するために使用されます。
5. event.getEventBusDetails(): 設定されたイベントアクションやルールなどのイベントバスの詳細を取得します。
6. event.getAction(): デフォルトのEvent Listenerでイベントをトリガーしたcatalystコンポーネントで実行されたアクション（テーブルへのデータ挿入やユーザーサインアップなど）を取得します
7. event.getSourceEntityId(): イベントが発生したソースエンティティのID（テーブルIDやキャッシュのセグメントIDなど）を取得します

Python

Catalyst Event Functionは、Pythonでも2つのモジュールをサポートしています：contextとevent。

contextモジュールには、以下の組み込みメソッドが含まれています：

1. context.close_with_success(): Functionが正常に実行されたことを示します。Functionの最後に使用する必要があります。

2. context.close_with_failure(): Functionの実行が失敗したことを示します。Functionの最後に使用する必要があります。

3. context.get_remaining_execution_time_ms(): Functionの残りの実行時間を取得するために使用できます。

4. context.get_max_execution_time_ms(): このメソッドは、Functionの最大実行時間を取得するために使用でき、15分の定数値です。

eventモジュールには、以下の組み込みメソッドが含まれています：

1. event.get_event_bus_details(): 設定されたイベントアクションやルールなどのイベントバスの詳細を取得します。
2. event.get_project_details(): プロジェクトIDやプロジェクト名などのプロジェクト詳細を取得します。
3. event.get_data(): Event Functionに関連付けられたイベントのデータを取得します。
4. event.get_time(): Functionを呼び出したイベントの発生時間を取得します。
5. event.get_source(): DataStore、Cache、Authentication、FileStore、Githubおよびwebclientなど、イベントをトリガーしたソースの名前を取得します。
6. event.get_action(): デフォルトのEvent Listenerでイベントをトリガーしたcatalystコンポーネントで実行されたアクション（テーブルへのデータ挿入やユーザーサインアップなど）を取得します。
7. event.get_source_entity_id(): イベントが発生したソースエンティティのID（テーブルIDやキャッシュのセグメントIDなど）を取得します。