1. Homepage
  2. APIkit (4.x)
  3. APIkit for GraphQL

  4. APIkit for GraphQL Module リファレンス

APIkit for GraphQL Module リファレンス

設定

設定

デフォルト設定

パラメーター

名前

型

説明

デフォルト値

必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

API definition (API 定義)

String (文字列)

API 定義リソースへのパスを定義します。例: resource::7ddfc767-c5b3-4583-9997-a468e251acd2:posts:1.0.0:graphql:zip:api.graphql

x

Introspection Enabled (イントロスペクション有効)

Boolean (ブール)

スキーマのイントロスペクションを有効化します。

false

Max Query Depth Allowed (最大クエリ深度)

Number (数値)

クエリで許される最大深度。値は 1 よりも大きい必要があります。

100

Max Query Complexity Allowed (最大クエリ複雑さ)

Number (数値)

クエリに含めることができるデータ項目の最大数。値は 1 よりも大きい必要があります。

100

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

x

関連操作

関連付けられたソース

操作

Route (ルート)

<graphql-router:route>

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Content (コンテンツ)

任意

メッセージのコンテンツ (通常はペイロード)

#[payload]

Output MIME Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

反復可能なストリーミング戦略の設定。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

出力

Type (型)

任意

設定

Serialize (シリアル化)

<graphql-router:serialize>

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Inbound Content (インバウンドコンテンツ)

任意

メッセージのコンテンツ (通常はペイロード)

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Object Type Name (オブジェクト種別名)

String (文字列)

オブジェクト種別名。

x

Field Name (項目名)

String (文字列)

項目名。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

出力

Type (型)

任意

設定

Serialize Batch (バッチシリアル化)

<graphql-router:serialize-batch>

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Type Name (オブジェクト種別名)

String (文字列)

オブジェクト種別名。

x

Inbound Content (インバウンドコンテンツ)

任意

メッセージのコンテンツ (通常はペイロード)

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

出力

型

任意

設定

ソース

データフェッチャー

<graphql-router:data-fetcher>

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Output MIME Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

Streaming Strategy (ストリーミング戦略)

反復可能なストリーミング戦略の設定。

Redelivery Policy (再配信ポリシー)

再配信ポリシー

同じメッセージの再配信を処理するためのポリシー。

Object Type Name (オブジェクト種別名)

String (文字列)

オブジェクト種別名。

x

Field Name (項目名)

String (文字列)

項目名。

Body Content (本文コンテンツ)

任意

メッセージのコンテンツ (通常はペイロード)

#[payload]

出力

型

任意

Attributes Type (属性型)

* Data Fetcher Attributes (データフェッチャー属性)

設定

データローダー

<graphql-router:data-loader>

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Type Name (オブジェクト種別名)

String (文字列)

オブジェクト種別名。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

Redelivery Policy (再配信ポリシー)

再配信ポリシー

同じメッセージの再配信を処理するためのポリシー。

Body Content (本文コンテンツ)

任意

メッセージのコンテンツ (通常はペイロード)

#[payload]

出力

型

Any の配列

設定

型

Data Fetcher Attributes (データフェッチャー属性)

項目 型 説明 デフォルト値 必須

Alias (別名)

String (文字列)

照会された項目の別名

false

Arguments (引数)

Object (オブジェクト)

照会された項目の引数

false

Selected Fields (選択済みの項目)

Object (オブジェクト)

この複合型から選択されたサブ項目のマップ

Source (ソース)

Any (任意)

取得した項目の親の実際の値

false

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ランダムアクセスを提供するために割り当てられるメモリ量。ストリームにバッファ容量を超えるデータが含まれる場合、バッファは ​bufferSizeIncrement​ 属性に従って上限の ​maxInMemorySize​ まで拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 またはそれ以下に設定すると、バッファは拡張されません。バッファが満杯になると ​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが返されます。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用されるメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらの属性は、この単位で表されます。

Repeatable File Store Stream (反復可能なファイルストアストリーム)

項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。このサイズを超えると、ストリームはコンテンツをディスクにバッファします。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize​ を表す単位。

Redelivery Policy (再配信ポリシー)

項目 型 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

処理失敗メッセージをトリガーするまでに、メッセージを再配信して処理を失敗できる最大回数。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの SHA-256 になります。

Message Identifier (メッセージ識別子)

メッセージを識別するために使用する戦略。

Object Store (オブジェクトストア)

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストア。

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

項目 型 説明 デフォルト値 必須

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する式。このプロパティは、useSecureHash が false の場合にのみ設定できます。