Contact Us 1-800-596-4880
  1. Homepage
  2. APIkit (4.x)
  3. APIkit for GraphQL

  4. Module Reference

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.

x

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

x

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.

x

Associated Operations

Associated Sources

Operations

Route

<graphql-router:route>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Content

Any

Content of the message (usually, the payload)

#[payload]

Output MIME Type

String

The MIME type of the payload that this operation outputs

Output Encoding

String

The encoding of the payload that this operation outputs

Config Ref

ConfigurationProvider

The name of the configuration you use to execute this component

x

Streaming Strategy

Configure repeatable streaming strategy

Target Variable

String

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

Target Value

String

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

#[payload]

Output

Type

Any

Configurations

Serialize

<graphql-router:serialize>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration you use

x

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

x

Object Type Name

String

The object-type name

x

Field Name

String

The field name

Target Variable

String

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

Target Value

String

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

#[payload]

Output

Type

Any

Configurations

Serialize Batch

<graphql-router:serialize-batch>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration you use

x

Object Type Name

String

The object-type name

x

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

x

Target Variable

String

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

Target Value

String

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

#[payload]

Output

Type

Any

Configurations

Sources

Data Fetcher

<graphql-router:data-fetcher>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration you use

x

Output MIME Type

String

The MIME type of the payload that this operation outputs

Output Encoding

String

The encoding of the payload that this operation outputs

Config Ref

ConfigurationProvider

The name of the configuration you use to execute this component

x

Primary Node Only

Boolean

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

Streaming Strategy

Configure repeatable streaming strategy

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Object Type Name

String

The object-type name

x

Field Name

String

The field name

Body Content

Any

Content of the message (usually, the payload)

#[payload]

Output

Type

Any

Attributes Type

* Data Fetcher Attributes

Configurations

Data Loader

<graphql-router:data-loader>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration you use

x

Object Type Name

String

The object-type name

x

Config Ref

ConfigurationProvider

The name of the configuration you use to execute this component

x

Primary Node Only

Boolean

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

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Body Content

Any

Content of the message (usually, the payload)

#[payload]

Output

Type

Array of Any

Configurations

Types

Data Fetcher Attributes

Field Type Description Default Value Required

Alias

String

Alias of the queried field

false

Arguments

Object

Arguments of the queried field

false

Selected Fields

Object

Map of subfields selected from this compound type

Source

Any

Actual value of the fetched field parent

false

Repeatable in Memory Stream

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 buffer capacity, then it is expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

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.

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.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

These attributes are expressed in this unit.

Repeatable File Store Stream

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.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit for expressing maxInMemorySize

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.

Message Digest Algorithm

String

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

Message Identifier

The strategy to use to identify the messages

Object Store

ObjectStore

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

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

Id Expression

String

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