APIkit for GraphQL Module Reference

Configurations

Config

Default configuration

Parameters

Name

Type

Description

Default Value

Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

None

Yes

API definition

String

Defines the path to the API definition resource, for example: resource::7ddfc767-c5b3-4583-9997-a468e251acd2:posts:1.0.0:graphql:zip:api.graphql

None

Yes

Introspection Enabled

Boolean

Enables schema introspection.

false

Max Query Depth Allowed

Number

The maximum depth a query can have. The value must be greater than 1.

100

Max Query Complexity Allowed

Number

The maximum number of data fields a query can include. The value must be greater than 1.

100

Name

String

The identifier of this element is used to reference it in other components.

None

Yes

Associated Sources

Data Fetcher
Data Loader

Operations

Route

<graphql-router:route>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use	None	Yes
Content	Any	Content of the message (usually, the payload)	#[payload]	No
Output MIME Type	String	The MIME type of the payload that this operation outputs.	None	No
Output Encoding	String	The encoding of the payload that this operation outputs	None	No
Config Ref	ConfigurationProvider	The name of the configuration you use to execute this component	None	Yes
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream Non-Repeatable Stream	Configure repeatable streaming strategy	None	No
Target Variable	String	The name of a variable on which the operation output is placed	None	No
Target Value	String	An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable	#[payload]	No

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use

None

Yes

Content

Any

Content of the message (usually, the payload)

#[payload]

Output MIME Type

String

The MIME type of the payload that this operation outputs.

None

Output Encoding

String

The encoding of the payload that this operation outputs

None

Config Ref

ConfigurationProvider

The name of the configuration you use to execute this component

None

Yes

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
Non-Repeatable Stream

Configure repeatable streaming strategy

None

Target Variable

String

The name of a variable on which the operation output is placed

None

Target Value

String

An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable

#[payload]

Output

Type

Any

Configurations

Config

Serialize

<graphql-router:serialize>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration you use	None	Yes
Inbound Content	Any	Content of the message (usually, the payload)	#[payload]	No
Config Ref	ConfigurationProvider	The name of the configuration you use to execute this component	None	Yes
Object Type Name	String	The object-type name	None	Yes
Field Name	String	The field name	None	No
Target Variable	String	The name of a variable on which the operation output is placed	None	No
Target Value	String	An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable	#[payload]	No

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration you use

None

Yes

Inbound Content

Any

Content of the message (usually, the payload)

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration you use to execute this component

None

Yes

Object Type Name

String

The object-type name

None

Yes

Field Name

String

The field name

None

Target Variable

String

The name of a variable on which the operation output is placed

None

Target Value

String

An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable

#[payload]

Output

Type

Any

Configurations

Config

Serialize Batch

<graphql-router:serialize-batch>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration you use	None	Yes
Object Type Name	String	The object-type name	None	Yes
Inbound Content	Any	Content of the message (usually, the payload)	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration you use to execute this component	None	Yes
Target Variable	String	The name of a variable on which the operation output is placed	None	No
Target Value	String	An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable	#[payload]	No

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration you use

None

Yes

Object Type Name

String

The object-type name

None

Yes

Inbound Content

Any

Content of the message (usually, the payload)

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration you use to execute this component

None

Yes

Target Variable

String

The name of a variable on which the operation output is placed

None

Target Value

String

An expression that is evaluated against the operation output and the effect of that expression is stored in the target variable

#[payload]

Output

Type

Any

Configurations

Config

Sources

Data Fetcher

<graphql-router:data-fetcher>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration you use	None	Yes
Output MIME Type	String	The MIME type of the payload that this operation outputs	None	No
Output Encoding	String	The encoding of the payload that this operation outputs	None	No
Config Ref	ConfigurationProvider	The name of the configuration you use to execute this component	None	Yes
Primary Node Only	Boolean	Whether this source must only be executed on the primary node when running in a cluster	None	No
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream Non-Repeatable Stream	Configure repeatable streaming strategy	None	No
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message	None	No
Object Type Name	String	The object-type name	None	Yes
Field Name	String	The field name	None	No
Body Content	Any	Content of the message (usually, the payload)	#[payload]

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration you use

None

Yes

Output MIME Type

String

The MIME type of the payload that this operation outputs

None

Output Encoding

String

The encoding of the payload that this operation outputs

None

Config Ref

ConfigurationProvider

The name of the configuration you use to execute this component

None

Yes

Primary Node Only

Boolean

Whether this source must only be executed on the primary node when running in a cluster

None

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
Non-Repeatable Stream

Configure repeatable streaming strategy

None

Redelivery Policy

Defines a policy for processing the redelivery of the same message

None

Object Type Name

String

The object-type name

None

Yes

Field Name

String

The field name

None

Body Content

Any

Content of the message (usually, the payload)

#[payload]

Output

Type

Any

Attributes Type

* Data Fetcher Attributes

Configurations

Config

Data Loader

<graphql-router:data-loader>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration you use	None	Yes
Object Type Name	String	The object-type name	None	Yes
Config Ref	ConfigurationProvider	The name of the configuration you use to execute this component	None	Yes
Primary Node Only	Boolean	Whether this source should only be executed on the primary node when running in a cluster	None	No
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message	None	No
Body Content	Any	Content of the message (usually, the payload)	#[payload]

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration you use

None

Yes

Object Type Name

String

The object-type name

None

Yes

Config Ref

ConfigurationProvider

The name of the configuration you use to execute this component

None

Yes

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

None

Redelivery Policy

Defines a policy for processing the redelivery of the same message

None

Body Content

Any

Content of the message (usually, the payload)

#[payload]

Output

Type

Array of Any

Configurations

Config

Types

Data Fetcher Attributes

Field	Type	Description	Default Value	Required
Alias	String	Alias of the queried field	None	No
Arguments	Object	Arguments of the queried field	None	No
Selected Fields	Object	Map of subfields selected from this compound type	None	No
Source	Any	Actual value of the fetched field parent	None	No

Field

Type

Description

Default Value

Required

Alias

String

Alias of the queried field

None

Arguments

Object

Arguments of the queried field

None

Selected Fields

Object

Map of subfields selected from this compound type

None

Source

Any

Actual value of the fetched field parent

None

Repeatable in Memory Stream

Field Type Description Default Value Required

Field	Type	Description	Default Value	Required
Initial Buffer Size	Number	The amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than the buffer capacity, then it is expanded according to the `bufferSizeIncrement` attribute, with an upper limit of `maxInMemorySize`.	None	No
Buffer Size Increment	Number	How much buffer size expands if it exceeds its initial size. A value of zero or lower specifies that the buffer doesn’t expand. When the buffer is full, a `STREAM_MAXIMUM_SIZE_EXCEEDED` error occurs.	None	No
Max Buffer Size	Number	The maximum amount of memory used. If more is used, a `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised. A value lower or equal to zero means no limit.	None	No
Buffer Unit	Enumeration, one of: BYTE KB MB GB	These attributes are expressed in this unit.	None	No

Initial Buffer Size

Number

The amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than the buffer capacity, then it is expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

None

Buffer Size Increment

Number

How much buffer size expands if it exceeds its initial size. A value of zero or lower specifies that the buffer doesn’t expand. When the buffer is full, a STREAM_MAXIMUM_SIZE_EXCEEDED error occurs.

None

Max Buffer Size

Number

The maximum amount of memory used. If more is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

None

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

These attributes are expressed in this unit.

None

Repeatable File Store Stream

Field Type Description Default Value Required

Field	Type	Description	Default Value	Required
In Memory Size	Number	Defines the maximum memory that the stream uses to keep data in memory. If it consumes more, the stream buffers the content on disk.	None	No
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit for expressing `maxInMemorySize`	None	No

In Memory Size

Number

Defines the maximum memory that the stream uses to keep data in memory. If it consumes more, the stream buffers the content on disk.

None

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit for expressing maxInMemorySize

None

Redelivery Policy

Field	Type	Description	Default Value	Required
Max Redelivery Count	Number	The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a "Process failed" message.	None	No
Message Digest Algorithm	String	The secure hashing algorithm to use. If not set, the default is SHA-256.	SHA-256	No
Message Identifier	Redelivery Policy Message Identifier	The strategy to use to identify the messages	None	No
Object Store	ObjectStore	The object store where the redelivery counter for each message is stored	None	No

Field

Type

Description

Default Value

Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a "Process failed" message.

None

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

SHA-256

Message Identifier

Redelivery Policy Message Identifier

The strategy to use to identify the messages

None

Object Store

ObjectStore

The object store where the redelivery counter for each message is stored

None

Redelivery Policy Message Identifier

Field	Type	Description	Default Value	Required
Use Secure Hash	Boolean	Whether to use a secure hash algorithm to identify a redelivered message	None	No
Id Expression	String	Expressions to use to determine when a message has been redelivered. You can only set this property if useSecureHash is false.	None	No

Field

Type

Description

Default Value

Required

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

None

Id Expression

String

Expressions to use to determine when a message has been redelivered. You can only set this property if useSecureHash is false.

None