Basic I/O Functions

はじめに

Basic I/O Functionsは、さまざまなCatalystコンポーネント間で基本的な入出力操作、計算、およびシンプルなHTTP操作を実行するために使用されます。Basic I/O FunctionsはJSON形式で入出力を処理します。

Basic I/O Functionのエンドポイントは、Function URLを通じて直接アクセスできます。Function URLはFunctionの作成時に生成され、Functionに直接アクセスしてさまざまな条件でテストすることができます。

CatalystコンソールからBasic I/O Functionを作成し、そこでコーディングおよびテストするか、CLIを使用してFunctionを初期化し、テスト後にコンソールにデプロイできます。CLIでは、NodeシェルやローカルホストでのFunction提供を通じてBasic I/O Functionsをテストすることもできます。

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

Basic I/O Functionsの操作を練習するには、こちらのチュートリアルを参照してください。

Function構造

Java、Node.js、Pythonのメインファンクションファイルは、Functionの作成時に各Functionタイプごとに異なるデフォルトコードとモジュールで初期化されます。

Functionスタックセクションで説明されているように、Java、Node.js、またはPython Functionの構造には、一般的にメインファンクションファイルと依存関係および設定ファイルが含まれています。Node.js環境でBasic I/O Functionを作成する場合、Catalyst Node.js SDKあり・なしで作成することを選択できます。SDKなしで含める場合、Nodeモジュールやその他のNode依存関係ファイルは追加されません。Catalyst Functionsの汎用的なFunctionディレクトリ構造と設定ファイルの詳細については、プロジェクトディレクトリ構造ヘルプページを参照してください。

Java、Node.js、またはPythonのメインファンクションに含まれるモジュールについて説明する前に、Functionが初期化されるデフォルトコードを確認しましょう。

Catalystは、Basic I/O Java Functionを以下のシンプルな入出力操作のデフォルトコードで初期化します。

Basic I/O Node.js Functionも、シンプルな入出力操作を含むデフォルトコードで初期化されます。

Basic I/O Python Functionは、以下のシンプルな入出力操作を含むデフォルトコードで初期化されます。

def handler(context, basicio):
basicio.write('Hello from {{_MAIN_}}')
basicio.get_argument('name')
context.log('Successfully executed basicio function')
context.close()

Java、Node.js、Pythonモジュール

Catalyst Basic I/O Functionは、Node.jsおよびPythonプラットフォームで2つのモジュールを含んでいます：contextとbasicIO。

contextモジュール（Node.jsおよびPython）には、以下の組み込みメソッドが含まれています：

1. context.close(): Functionの終了を示します。Functionの最後に使用する必要があります。
2. log(*args): このメソッドは、Functionで渡された引数のセットを出力するために使用されます。

イベントFunctionの残りの実行時間と最大実行時間を取得するために、contextモジュールには以下のメソッドが含まれています：

Node.js:

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

basicIOモジュール（Node.jsおよびPython）には、以下の組み込みメソッドが含まれています：

1. basicIO.write(): 出力を表示します。String出力のみ取得できます。このメソッドはFunction内の1か所でのみ使用できます。出力でサポートされる最大メモリは1MBです。
2. basicIO.setStatus(): エラーステータスコードを設定するオプションのメソッドです。デフォルトのステータスコードは次のとおりです：成功した実行にはキーoutputを返すステータス200、失敗した実行にはerrorオブジェクトにプッシュされJSONレスポンスを返すステータス500。カスタムステータスコードを設定することもできます。
3. basicIO.getArgument(): Functionの個々のパラメータを取得します。URLのクエリ文字列として、またはJSONボディで渡すことができます。両方で渡した場合、クエリ文字列が優先されます。

JavaのBasic I/O Functionには、Node.jsやPythonと同じモジュールと組み込みメソッドが含まれています。Javaでサポートされている追加のメソッドは次のとおりです：

1. context.getOrigin(): Functionタイプを取得します
2. basicIO.getAllArguments(): Functionのすべてのパラメータを取得します
   

Function URL

前述のとおり、Basic I/O Functionのエンドポイントは、一意の呼び出しURLを通じて直接アクセスできます。URLを通じて手動で呼び出し、必要に応じて入力を渡してレスポンスを取得できます。このURLをアプリケーションのコードに実装するか、必要に応じて使用できます。このFunction URLはFunctionの作成時に自動的に生成されます。

Basic I/O Functionの本番URLは、次の形式です：https://project_domain_name.catalystserverless.com/server/function_name/execute

開発環境では、URLにdevelopmentキーが含まれます：https://project_domain_name.development.catalystserverless.com/server/function_name/execute

• https://project_domain_name.catalystserverless.com は、Catalystアプリケーションのアプリドメインです。

• /server はFunctionであることを示します。

• URLはFunction名で識別されます。

• /execute はBasic I/O Functionであることを示します。

FunctionのURLはコンソールから、またはCatalyst CLIからFunctionをデプロイした後にターミナルで取得できます。

CatalystではコンソールからBasic I/O Functionsをテストできるため、Function内のパラメータのキーと値を直接追加してテストできます。詳細については、コンソールからのFunctions操作セクションを参照してください。

ブラウザを通じてFunction URLを呼び出し、URLにクエリ文字列としてパラメータを渡すこともできます。例えば、名前を取得して表示するシンプルなFunctionでは、_name_というパラメータの値をクエリ文字列として渡してURLを呼び出します。

Functionの出力がブラウザウィンドウに表示されます。

ログへのプッシュ

Catalyst Logsは、すべてのFunction実行のログを必要な詳細とともに表示します。Function実行はログに自動的に記録されます。ただし、Basic I/O Functionの実行レスポンスデータを手動でログにプッシュすることもできます。

Catalystでは、最大1500文字をログに書き込むことができます。_Info_や_Warning_など、異なるログレベルにレスポンスを個別にプッシュすることもできます。

Basic I/O Functionのレスポンスデータは、次のメソッドを使用してログにプッシュできます：context.log()。

このステートメントは、Basic I/O Functionが初期化されるデフォルトコードで確認でき、ユーザーから受け取った入力がログにプッシュされ、ロガーレベルも手動で設定されます。