Contact Us 1-800-596-4880
  1. Homepage
  2. Einstein AI Connector (2.0)

  3. Einstein AI Connector Reference

All Connectors

Einstein AI Connector 2.0 Reference

Einstein AI Connector provides access to the Salesforce Einstein Trust Layer through the Models APIs.

Configurations

Configuration

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

OAuth Client Credentials

The connection types to provide to this configuration.

x

Read Timeout

Number

Read timeout value.

30

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

OAuth Client Credentials
Parameters
Name Type Description Default Value Required

Proxy Configuration

One of:

Configures a proxy for outbound connections.

Max Connections

Number

Maximum number of outbound connections to keep open at the same time.

-1

Connection Timeout

Number

Amount of time to wait when initially establishing the TCP connection between the connector and Salesforce Agent before throwing an exception if the connection fails.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Connection Idle Timeout

Number

Number of units that a connection can remain idle before it is closed.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

TLS Configuration

Tls

Protocol to use for communication.

Reconnection

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.

Client Id

String

The OAuth public client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret that corresponds to the client ID.

x

Token Url

String

The service provider’s token endpoint URL.

https://{salesforceorg}/services/oauth2/token

Scopes

String

The OAuth scopes to request during the OAuth dance. If not provided, it defaults the scopes in the annotation.

Object Store

String

A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule runtime automatically provisions the default one.

Operations

AGENT Define Prompt Template

<ms-einstein-ai:agent-define-prompt-template>

Use the Agent define prompt template operation to use specific prompt templates. The prompt template language is a simple way to define and compose AI functions using plain text. You can use it to create natural language prompts, generate responses, extract information, invoke other prompts, or perform any other task that can be expressed with text.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Template

String

Prompt template for the operation.

#[payload]

Instructions

String

Instructions for the LLM, outlining the goals of the task.

x

Dataset

String

Dataset for the LLM to evaluate using the provided template and instructions.

x

Output Mime Type

String

MIME type of the payload this operation outputs.

Output Encoding

String

Encoding of the payload this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

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

Model API Name

String

Name of the API model that interacts with the LLM.

sfdc_ai__DefaultOpenAIGPT35Turbo

Probability

Number

Probability of the model API staying accurate.

0.8

Locale

String

Localization information, which can include the default locale, input locale(s), and expected output locale(s).

en_US

Read Timeout

Number

Read timeout value.

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Einstein Response Attributes

For Configurations

Throws

  • MS-EINSTEIN-AI:CHAT_FAILURE

  • MS-EINSTEIN-AI:CONNECTIVITY

  • MS-EINSTEIN-AI:RETRY_EXHAUSTED

CHAT Answer Prompt

<ms-einstein-ai:chat-answer-prompt>

The Chat answer prompt operation sends a prompt request to the configured LLM. It uses a plain text prompt as input and responds with a plain text answer.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Prompt

String

Plain text prompt to send to the LLM.

#[payload]

Output Mime Type

String

MIME type of the payload this operation outputs.

Output Encoding

String

Encoding of the payload this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

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

Model API Name

String

Name of the API model that interacts with the LLM.

sfdc_ai__DefaultOpenAIGPT35Turbo

Probability

Number

Probability of the model API staying accurate.

0.8

Locale

String

Localization information, which can include the default locale, input locale(s), and expected output locale(s).

en_US

Read Timeout

Number

Read timeout value.

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Einstein Response Attributes

For Configurations

Throws

  • MS-EINSTEIN-AI:CHAT_FAILURE

  • MS-EINSTEIN-AI:CONNECTIVITY

  • MS-EINSTEIN-AI:RETRY_EXHAUSTED

CHAT Generate From Messages

<ms-einstein-ai:chat-generate-from-messages>

The Chat generate from messages operation is a prompt request operation with provided messages to the configured LLM. It uses a plain text prompt as input and responds with a plain text answer.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Messages

Any

#[payload]

Output Mime Type

String

MIME type this operation outputs.

Output Encoding

String

Encoding of the payload this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

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

Model API Name

String

Name of the API model that interacts with the LLM.

sfdc_ai__DefaultOpenAIGPT35Turbo

Probability

Number

Probability of the model API staying accurate.

0.8

Locale

String

Localization information, which can include the default locale, input locale(s), and expected output locale(s).

en_US

Read Timeout

Number

Read timeout value.

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Parameters

For Configurations

Throws

  • MS-EINSTEIN-AI:CHAT_FAILURE

  • MS-EINSTEIN-AI:CONNECTIVITY

  • MS-EINSTEIN-AI:RETRY_EXHAUSTED

EMBEDDING Adhoc File Query

<ms-einstein-ai:embedding-adhoc-file-query>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Prompt

String

Plain text prompt to send to the LLM.

x

Input Stream

Any

Document content to ingest into the embedding store.

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

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

Model API Name

String

Name of the API model that interacts with the LLM.

sfdc_ai__DefaultOpenAITextEmbeddingAda_002

File Type

Enumeration, one of:

  • PDF

  • TEXT

  • CSV

Type of the document provided as input.

PDF

Option Type

Enumeration, one of:

  • FULL

  • PARAGRAPH

How to split the loaded document before embedding.

FULL

Read Timeout

Number

Read timeout value.

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-EINSTEIN-AI:CONNECTIVITY

  • MS-EINSTEIN-AI:EMBEDDING_OPERATIONS_FAILURE

  • MS-EINSTEIN-AI:RAG_FAILURE

  • MS-EINSTEIN-AI:RETRY_EXHAUSTED

  • MS-EINSTEIN-AI:TOOLS_OPERATION_FAILURE

EMBEDDING Generate From File

<ms-einstein-ai:embedding-generate-from-file>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Input Stream

Any

#[payload]

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

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

Model API Name

String

sfdc_ai__DefaultOpenAITextEmbeddingAda_002

File Type

Enumeration, one of:

  • PDF

  • TEXT

  • CSV

Type of the document provided as input.

PDF

Option Type

Enumeration, one of:

  • FULL

  • PARAGRAPH

How to split the loaded document before embedding.

FULL

Read Timeout

Number

Read timeout value.

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • MS-EINSTEIN-AI:CONNECTIVITY

  • MS-EINSTEIN-AI:EMBEDDING_OPERATIONS_FAILURE

  • MS-EINSTEIN-AI:RAG_FAILURE

  • MS-EINSTEIN-AI:RETRY_EXHAUSTED

  • MS-EINSTEIN-AI:TOOLS_OPERATION_FAILURE

EMBEDDING Generate From Text

<ms-einstein-ai:embedding-generate-from-text>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Text

String

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

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

Model API Name

String

sfdc_ai__DefaultOpenAITextEmbeddingAda_002

Read Timeout

Number

Read timeout value.

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Response Parameters

For Configurations

Throws

  • MS-EINSTEIN-AI:CONNECTIVITY

  • MS-EINSTEIN-AI:EMBEDDING_OPERATIONS_FAILURE

  • MS-EINSTEIN-AI:RAG_FAILURE

  • MS-EINSTEIN-AI:RETRY_EXHAUSTED

  • MS-EINSTEIN-AI:TOOLS_OPERATION_FAILURE

RAG Adhoc Load Document

<ms-einstein-ai:rag-adhoc-load-document>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Prompt

String

Plain text prompt to send to the LLM.

x

Input Stream

Any

Document content to ingest into the embedding store.

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

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

Model API Name

String

Name of the API model that interacts with the LLM.

sfdc_ai__DefaultOpenAIGPT35Turbo

Probability

Number

Probability of the model API staying accurate.

0.8

Locale

String

Localization information, which can include the default locale, input locale(s), and expected output locale(s).

en_US

Embedding Name

String

sfdc_ai__DefaultOpenAITextEmbeddingAda_002

Option Type

Enumeration, one of:

  • FULL

  • PARAGRAPH

How to split the loaded document before embedding.

FULL

File Type

Enumeration, one of:

  • PDF

  • TEXT

  • CSV

Type of the document provided as input.

PDF

Read Timeout

Number

Read timeout value.

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Einstein Response Attributes

For Configurations

Throws

  • MS-EINSTEIN-AI:CONNECTIVITY

  • MS-EINSTEIN-AI:EMBEDDING_OPERATIONS_FAILURE

  • MS-EINSTEIN-AI:RAG_FAILURE

  • MS-EINSTEIN-AI:RETRY_EXHAUSTED

  • MS-EINSTEIN-AI:TOOLS_OPERATION_FAILURE

Tools Use Ai Service

<ms-einstein-ai:tools-use-ai-service>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Prompt

String

Plain text prompt to send to the LLM.

#[payload]

Input Stream

Any

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

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

Model API Name

String

Name of the API model that interacts with the LLM.

sfdc_ai__DefaultOpenAIGPT35Turbo

Probability

Number

Probability of the model API staying accurate.

0.8

Locale

String

Localization information, which can include the default locale, input locale(s), and expected output locale(s).

en_US

Read Timeout

Number

Read timeout value.

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Einstein Response Attributes

For Configurations

Throws

  • MS-EINSTEIN-AI:CONNECTIVITY

  • MS-EINSTEIN-AI:EMBEDDING_OPERATIONS_FAILURE

  • MS-EINSTEIN-AI:RAG_FAILURE

  • MS-EINSTEIN-AI:RETRY_EXHAUSTED

  • MS-EINSTEIN-AI:TOOLS_OPERATION_FAILURE

Unauthorize

<ms-einstein-ai:unauthorize>

Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the OAuth dance.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

For Configurations

Types

Tls

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Key Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

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

Password

String

Password that protects the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Key Store

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.

Type

String

Type of keystore to use.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

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

Crl File

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

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

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Einstein Response Attributes

Field Type Description Default Value Required

Content Quality

Content Quality

Generation Id

String

Generation Parameters

Generation Parameters

Response Id

String

Response Parameters

Response Parameters

Content Quality

Content moderation details for generated content, including its safety and quality scores.

Field Type Description Default Value Required

Scan Toxicity

Scan Toxicity

Scans content for toxicity.

Scan Toxicity

Represents safety and toxicity data.

Field Type Description Default Value Required

Categories

Array of Categories

Is Detected

Boolean

Indicates whether a scan detected any toxic content. When the isDetected field is true, it indicates a high level of confidence that the content contains toxic language. When the isDetected field is false, it doesn’t necessarily mean there isn’t toxicity, but rather, that the model didn’t detect toxicity in the content.

Categories

The array of toxicity categories.

Field Type Description Default Value Required

Category Name

String

Name of the category.

Score

String

A toxicity score value from 0 to 1. A higher score means the response is more likely to be toxic.

Generation Parameters

Field Type Description Default Value Required

Annotations

Array of String

Finish Reason

String

Index

Number

Logprobs

String

Refusal

String

Response Parameters

Field Type Description Default Value Required

Model

String

Object

String

System Fingerprint

String

Token Usage

Token Usage

Token Usage

Field Type Description Default Value Required

Completion Token Details

Completion Tokens Details

Input Count

Number

Number of tokens the LLM receives from the prompt.

Output Count

Number

Number of tokens the LLM generates in response to the input tokens.

Prompt Token Details

Prompt Tokens Details

Total Count

Number

Completion Tokens Details

Requesting a large number of generated tokens completions can cause increased latencies.

Field Type Description Default Value Required

Accepted Prediction Tokens

Number

Number of accepted prediction tokens.

Audio Tokens

Number

Number of audio tokens completions.

Reasoning Tokens

Number

Number of tokens for reasoning and outputs.

Rejected Prediction Tokens

Number

Number of prediction tokens the LLM generated that were later discarded because they were deemed incorrect or not useful within the context.

Prompt Tokens Details

Field Type Description Default Value Required

Audio Tokens

Number

Number of audio tokens in the prompt.

Cached Tokens

Number

Number of cached tokens in the prompt.

Repeatable In-Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max Buffer Size.

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.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Max Buffer Size fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

Default Http Proxy Config

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

See Also

Back to top