# mulesoft Notion Connector - Full Documentation --- product: Notion Connector version: 0.1 --- # Notion Connector 0.1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Notion (Notion Connector) enables Mule applications to access the Notion API. > [!NOTE] Notion Connector is a beta connector that is subject to the Beta Services Terms at > [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/) or a written Unified > Pilot Agreement if executed by Customer, and the Non-GA Gen AI and Non-GA Credit Consumption terms > in the > [Product Terms Directory](https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992). > Use of this beta connector with external systems or services consumes > [Mule messages](https://docs.mulesoft.com/general/usage-metrics) and is at the Customer’s sole discretion. For information about compatibility and fixed issues, refer to the Notion Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Notion Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Code Builder or Anypoint Studio Before creating an app, you must have: - Credentials to access the Notion target resource - Anypoint Platform - The latest versions of Anypoint Code Builder or Anypoint Studio ## Next Step After you complete the prerequisites, you’re ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) or [Anypoint Code Builder](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Notion Connector Reference](https://docs.mulesoft.com/notion-connector/0.1/notion-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Notion Connector version: 0.1 --- # Notion Connector 0.1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Config Default configuration. #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Name

String

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

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

#### Connection Types ##### Bearer Auth ###### Parameters
NameTypeDescriptionDefault ValueRequired

baseUri

String

The base URI for the Notion API.

x

token

String

The authentication token for accessing the Notion API.

x

TLS Configuration

Configures TLS to provide secure communications for the connector.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

## Supported Operations - [Append Block Children](#AppendBlockChildren) - [Create A Database](#CreateADatabase) - [Create A Page](#CreateAPage) - [Create Comments](#CreateComments) - [Delete Block](#DeleteBlock) - [Get Block By Id](#GetBlockById) - [Get Block Children](#GetBlockChildren) - [Get Page Property Item](#GetPagePropertyItem) - [Get User by Id](#GetUserById) - [List Comments](#ListComments) - [List Users](#ListUsers) - [Retrieve A Comment](#RetrieveAComment) - [Search By Title](#SearchByTitle) - [Update Block](#UpdateBlock) - [Update Page](#UpdatePage) - [usersMe](#UsersMe) ## Operations ## Append Block Children `` Appends block children to a parent block. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the block to append children to.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the children blocks to append.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Create A Database `` Creates a database in a parent page or workspace. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the database properties.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:UNAUTHORIZED ## Create A Page `` Creates a page. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the page properties.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Create Comments `` Creates comments. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the comment content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Delete Block `` Deletes a block. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the block to delete.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Get Block By Id `` Retrieves a block by its identifier. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the block to retrieve.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Get Block Children `` Retrieves the children blocks of a parent block. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the parent block.

x

page_size

Number

The number of items to return per page.

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Array of Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Get Page Property Item `` Retrieves a specific property item from a page. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

page_id

String

The identifier of the page.

x

property_id

String

The identifier of the property.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Get User by Id `` Retrieves a user by their identifier. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the user to retrieve.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## List Comments `` Lists comments. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

block_id

String

The identifier of the block to list comments for.

page_size

Number

The number of items to return per page.

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Array of Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## List Users `` Lists users. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

page_size

Number

The number of items to return per page.

start_cursor

String

The cursor for pagination to start from.

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Array of Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Retrieve A Comment `` Retrieves a specific comment by its identifier. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

comment_id

String

The identifier of the comment to retrieve.

x

Notion-Version

String

The Notion API version to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:UNAUTHORIZED ## Search By Title `` Searches by title. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the search query.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Array of Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Update Block `` Updates the content of a block. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the block to update.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the updated block properties.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Update Page `` Updates the page. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

page_id

String

The identifier of the page to update.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the updated page properties.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## usersMe `` Retrieves information about the user. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Types ### Tls
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS trust store.

Key Store

Configures the TLS key store.

Revocation Check

Configures certificate revocation checking.

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom Ocsp Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### Crl File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

### Reconnect
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Max Idle Time attribute.

### Error Mapping
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

The source error type to map from.

Target

String

The target error type to map to.

x

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

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

### Repeatable File Store Iterable
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Objects field.

--- product: Notion Connector version: 1.0 is-latest-version: true --- # Notion Connector 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Notion (Notion Connector) enables Mule applications to access the Notion API. > [!NOTE] Notion Connector is a beta connector that is subject to the Beta Services Terms at > [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/) or a written Unified > Pilot Agreement if executed by Customer, and the Non-GA Gen AI and Non-GA Credit Consumption terms > in the > [Product Terms Directory](https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992). > Use of this beta connector with external systems or services consumes > [Mule messages](https://docs.mulesoft.com/general/usage-metrics) and is at the Customer’s sole discretion. For information about compatibility and fixed issues, refer to the Notion Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Notion Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Code Builder or Anypoint Studio Before creating an app, you must have: - Credentials to access the Notion target resource - Anypoint Platform - The latest versions of Anypoint Code Builder or Anypoint Studio ## Next Step After you complete the prerequisites, you’re ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) or [Anypoint Code Builder](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Notion Connector Reference](https://docs.mulesoft.com/notion-connector/latest/notion-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Notion Connector version: 1.0 is-latest-version: true --- # Notion Connector 1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Config Default configuration. #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Name

String

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

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

#### Connection Types ##### Bearer Auth ###### Parameters
NameTypeDescriptionDefault ValueRequired

baseUri

String

The base URI for the Notion API.

x

token

String

The authentication token for accessing the Notion API.

x

TLS Configuration

Configures TLS to provide secure communications for the connector.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

## Supported Operations - [Append Block Children](#AppendBlockChildren) - [Create A Database](#CreateADatabase) - [Create A Page](#CreateAPage) - [Create Comments](#CreateComments) - [Delete Block](#DeleteBlock) - [Get Block By Id](#GetBlockById) - [Get Block Children](#GetBlockChildren) - [Get Page Property Item](#GetPagePropertyItem) - [Get User by Id](#GetUserById) - [List Comments](#ListComments) - [List Users](#ListUsers) - [Retrieve A Comment](#RetrieveAComment) - [Search By Title](#SearchByTitle) - [Update Block](#UpdateBlock) - [Update Page](#UpdatePage) - [usersMe](#UsersMe) ## Operations ## Append Block Children `` Appends block children to a parent block. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the block to append children to.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the children blocks to append.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Create A Database `` Creates a database in a parent page or workspace. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the database properties.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:UNAUTHORIZED ## Create A Page `` Creates a page. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the page properties.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Create Comments `` Creates comments. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the comment content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Delete Block `` Deletes a block. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the block to delete.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Get Block By Id `` Retrieves a block by its identifier. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the block to retrieve.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Get Block Children `` Retrieves the children blocks of a parent block. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the parent block.

x

page_size

Number

The number of items to return per page.

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Array of Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Get Page Property Item `` Retrieves a specific property item from a page. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

page_id

String

The identifier of the page.

x

property_id

String

The identifier of the property.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Get User by Id `` Retrieves a user by their identifier. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the user to retrieve.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## List Comments `` Lists comments. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

block_id

String

The identifier of the block to list comments for.

page_size

Number

The number of items to return per page.

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Array of Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## List Users `` Lists users. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

page_size

Number

The number of items to return per page.

start_cursor

String

The cursor for pagination to start from.

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Array of Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Retrieve A Comment `` Retrieves a specific comment by its identifier. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

comment_id

String

The identifier of the comment to retrieve.

x

Notion-Version

String

The Notion API version to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:UNAUTHORIZED ## Search By Title `` Searches by title. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the search query.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Array of Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Update Block `` Updates the content of a block. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

ID

String

The identifier of the block to update.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the updated block properties.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Update Page `` Updates the page. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

page_id

String

The identifier of the page to update.

x

Notion-Version

String

The Notion API version to use.

body

Any

The request body containing the updated page properties.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:NOT\_FOUND - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## usersMe `` Retrieves information about the user. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Notion-Version

String

The Notion API version to use.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

### Output

Type

Any

Attributes Type

Any

### For Configurations - [Config](#Config) ### Throws - NOTION:BAD\_REQUEST - NOTION:CLIENT\_ERROR - NOTION:CONNECTIVITY - NOTION:FORBIDDEN - NOTION:SECURITY - NOTION:SERVER\_ERROR - NOTION:TIMEOUT - NOTION:TOO\_MANY\_REQUESTS - NOTION:UNAUTHORIZED ## Types ### Tls
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS trust store.

Key Store

Configures the TLS key store.

Revocation Check

Configures certificate revocation checking.

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom Ocsp Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### Crl File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

### Reconnect
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Max Idle Time attribute.

### Error Mapping
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

The source error type to map from.

Target

String

The target error type to map to.

x

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

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

### Repeatable File Store Iterable
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Objects field.