Cron Functions

はじめに

Cron Functionは、Cronに関連付けられた定期的なFunctionです。1回または定期的に呼び出す必要のあるジョブを実行するためにCron Functionを作成できます。

CatalystでCronを設定する際、Functionの実行またはサードパーティURLの呼び出しに関連付けることができます。

CronがFunctionに関連付けられている場合、Cronジョブはスケジュールに基づいてFunctionを自動的に呼び出します。1回限りのジョブの場合、Cronは指定された日時にFunctionを呼び出します。定期的な場合、Cronは設定された間隔（毎月特定の日時、毎日特定の時間など）でFunctionを呼び出します。

Cron Functionを手動で呼び出したり、コンソールでテストしたりすることはできません。ただし、CLIでfunctions:shellコマンドを使用してテストできます。Cron Functionは、Function実行の成功または失敗の判定以外のレスポンスを返しません。

Cron Functionモジュール

Java

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

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

1. CronRequest.getCronParam(): このメソッドは、Functionに渡された特定のパラメータの値を取得するために使用されます。
2. CronRequest.getAllCronParams(): このメソッドは、Functionに渡されたすべてのパラメータを取得するために使用されます。
3. CronRequest.getRemainingExecutionCount(): このメソッドは、Cronジョブの残りの実行インスタンスの詳細を取得するために使用されます。
4. CronRequest.getCronDetails(): このメソッドは、Cron IDやCron名などのCronの詳細を取得するために使用されます。
5. CronRequest.getProjectDetails(): プロジェクトIDやプロジェクト名などのプロジェクト詳細を取得するために使用されます。

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

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

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

Node.js

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

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

1. cronDetails.getCronParam(): このメソッドは、Functionに渡された特定のパラメータの値を取得するために使用されます。
2. cronDetails.getAllCronParam(): このメソッドは、Functionに渡されたすべてのパラメータを取得するために使用されます。
3. cronDetails.getRemainingExecutionCount(): Cronジョブの残りの実行インスタンスの詳細を取得します。
4. cronDetails.getCronDetails(): Cron IDやCron名などのCronの詳細を取得します。
5. cronDetails.getProjectDetails(): プロジェクトIDやプロジェクト名などのプロジェクト詳細を取得します。

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

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

Python

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

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

1. cron_details.get_cron_param() - このメソッドは、Functionに渡された特定のパラメータの値を取得するために使用されます。
2. cron_details.get_all_cron_params() - このメソッドは、Functionに渡されたすべてのパラメータを取得するために使用されます。
3. cron_details.get_remaining_execution_count() - Cronジョブの残りの実行インスタンスの詳細を取得します。
4. cron_details.get_cron_details() - Cron IDやCron名などのCronの詳細を取得します。
5. cron_details.get_project_details() - プロジェクトIDやプロジェクト名などのプロジェクト詳細を取得します。

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

1. context.get_max_execution_time_ms() - このメソッドは、Functionの最大実行時間を取得するために使用できます。Functionの最大実行時間は15分に設定されています。
2. context.get_remaining_execution_time_ms() - Functionの残りの実行時間を取得するために使用できます。
3. context.close_with_success() - Functionが正常に実行されたことを示すために使用できます。Functionの最後に使用する必要があります。
4. context.close_with_failure() - Functionの実行が失敗したことを示します。Functionの最後に使用する必要があります。