DataSense サポートの追加

静的メタデータとは、コンパイル時に既知で、コネクタの JAR ファイルにある型から使用できるメタデータです。単純な Java 型は、開発者がモデルで定義したカスタム POJO と同じように、この静的メタデータに属します。重要な点は、構造が明確に分かっていて、他のパラメーターに依存せずに調査できるということです。

動的メタデータとは、コンパイル時に型が未知のメタデータです。動的メタデータは、コネクタの設定に基づいてデザイン時に解決する必要があります。このメタデータには、さまざまなケースでいろいろな使い方があります。たとえば、型そのものは既知でも構造がサービス設定に依存するケース (例: システムのアカウントにユーザーがカスタマイズできる項目があるため、ユーザーのログイン情報に基づいてその構造を毎回検出しなければならない場合) や、すべてが動的であるため、記述されている構造が設定済みパラメーターに大きく依存するケース (例: 記述されている構造がサービス操作のペイロードであり、ユーザーの Sandbox に基づいたサービス定義にも依存する場合) があります。

動的メタデータを解決するには、現在のコンポーネント設定に従って必要な型構造を取得する方法を知っているメタデータリゾルバーに要素を関連付ける必要があります。詳細は「​メタデータリゾルバー​」を参照してください。

入力メタデータは、コンポーネントのパラメーターのタイプを解決します。各パラメーターは、同じコンポーネントの他のパラメーターが公開している種類のメタデータから分離された静的または動的メタデータを提供します。

動的メタデータのパラメーターは操作とソースでのみ使用できます。設定と接続のパラメーターは常に静的メタデータとなります。

コンポーネントの出力は、メタデータの静的または動的な解決にバインドされます。たとえば、​void​ 操作は、操作の出力が ​VoidType​ であることを示す静的メタデータを持ち、リモートサービスから ​User​ プロファイルをフェッチする操作は ​User​ タイプを動的に記述できます。

構造​についての説明にあるように、操作の出力結果には、ペイロードのデータと返されるメッセージの属性が含まれます。これらの属性の構造は、ペイロードの構造と同じくらい重要です。それぞれのメタデータを独立して記述することで、エンドユーザーにとっては使いやすくなります。ただし、一部のコンポーネントは属性を生成しないため、属性の動的メタデータの記述は常に任意で行います。

特定の戻り値のデータ型では、強制的にメタデータが動的に記述されます。これはエンドユーザーの使い勝手を向上させるための要件であり、型の記述が汎用的過ぎると使いづらくなるためです。

動的メタデータ構造を記述するには、どの型を表現するのかを知る必要があります。この型の参照を定義するには、記述する型の ID を含む ​@MetadataKeyId​ パラメーターを操作で指定します。

たとえば、汎用レコードを Amazon S3 に保存する操作があるとして、サポートされる各型の構造 (​Account​ や ​Organization​ など) を記述しておけば、デザインしやすくなります。この場合は、操作のパラメーターの 1 つに ID として ​Account​ または ​Organization​ を含む型の参照を定義します。このパラメーターは、バケットに保存するレコードの Account 構造または Organization 構造 (エンドユーザーが使うと決めた方) を記述します。

@MetadataKeyId​ パラメーターは常に必要というわけではなく、設定に応じて動的に変化する構造が (複数ではなく) 1 つしかない場合などには不要です。たとえば、接続用のログイン情報がシステム管理者用であるかどうかによって構造が変化する ​User​ エンティティなどです。

MetadataKey パラメーターを含める目的は、出力のメタデータと、キーが定義されているコンポーネントの入力を解決するためのパラメーター値を使用することです。そのため、入力、出力、または属性の MetadataResolver が存在しない場合には、MetadataKey を定義しないでください。SDK バージョン 1.3 以降では、MetadataKey パラメーターを持ちながらも出力リゾルバーや入力リゾルバーを持たないコンポーネントがコネクタに含まれていると、コンパイルに失敗します。

DataSense の動的要素を取得する場合は、メタデータリゾルバーを実装します。リゾルバーには多くの種類があり、それぞれ機能とユースケース (後述) が異なりますが、中心となる以下の概念は同じです。