Confluent Schema Registry Connector 1.0 Reference

Anypoint Connector for Confluent Schema Registry (Confluent Schema Registry Connector) enables interaction with Confluent’s Schema Registry to save and retrieve avro schemas to reduce the size of an avro message while it transports through the network.

Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

AUTO

Time to live

Number

Time that a cached schema lives.

0

Time to live time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS **MINUTES

  • HOURS

  • DAYS

Time unit for the Time to live field.

SECONDS

Persist cache

Boolean

Defines if the cache is persistent.

true

Name

String

ID used to reference this configuration.

x

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

Basic Auth Connection Provider

Basic HTTP authentication supported by the API.

Parameters

Name Type Description Default Value Required

Default Headers

Array of Default Header.

Query Parameters

Connection Timeout

Number

Timeout for establishing connections to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

* true

Mule uses persistent connections.

* false

Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Username

String

Username to authenticate the requests.

Password

String

Password to authenticate the requests.

Base Uri

String

Parameter base URI. Each instance or tenant gets its own.

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication.

HTTP

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Unsecured Connection Provider

Unauthenticated.

Parameters

Name Type Description Default Value Required

Default Headers

Array of Default Header.

Query Parameters

Connection Timeout

Number

Timeout for establishing connections to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

* true

Mule uses persistent connections.

* false

Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Base Uri

String

Parameter base URI. Each instance or tenant gets its own.

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication.

HTTP

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Create compatibility subject

<confluent-schema-registry:create-compatibility-subject>

Creates a compatibility subject. This operation makes an HTTP POST request to the /compatibility/subjects/{Subject}/versions/{Version} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Version

String

Version number (or latest).

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Delete subject

<confluent-schema-registry:delete-subject>

Deletes all schema versions under the subject. This operation makes an HTTP DELETE request to the /subjects/{Subject} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Permanent

Boolean

Determines whether to delete the subject permanently.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Number

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Delete subject version

<confluent-schema-registry:delete-subject-version>

Deletes a specific version of a subject. This operation makes an HTTP DELETE request to the /subjects/{Subject}/versions/{Version} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Version

String

Version number.

x

Permanent

Boolean

Determines whether to delete the subject permanently.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Get global compatibility level

<confluent-schema-registry:get-global-compatibility-level>

Gets the top level config. This operation makes an HTTP GET request to the /config endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Get schema by id

<confluent-schema-registry:get-schema-by-id>

Fetch a schema by a globally unique ID. This operation makes an HTTP GET request to the /schemas/ids/{Id} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Id

String

Globally unique ID.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Get schema for subject version

<confluent-schema-registry:get-schema-for-subject-version>

Gets the avro schema for a specified version of the subject. Returns only the unescaped schema. This operation makes an HTTP GET request to the /subjects/{Subject}/versions/{Version}/schema endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Version

String

Version number (or latest).

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Get subject by version

<confluent-schema-registry:get-subject-by-version>

Gets a specific version of the schema registered under the subject. This operation makes an HTTP GET request to the /subjects/{Subject}/versions/{Version} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Version

String

Version number (or latest).

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Get subject config

<confluent-schema-registry:get-subject-config>

Gets the subject config. This operation makes an HTTP GET request to the /config/{Subject} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Get subject versions

<confluent-schema-registry:get-subject-versions>

Gets a list of versions registered under the specified subject. This operation makes an HTTP GET request to the /subjects/{Subject}/versions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Number

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Get Subjects

<confluent-schema-registry:get-subjects>

Lists all subjects. This operation makes an HTTP GET request to the /subjects endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of String

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Is schema registered

<confluent-schema-registry:is-schema-registered>

Checks if a schema is registered under the subject. This operation makes an HTTP POST request to the /subjects/{Subject} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Register schema for subject

<confluent-schema-registry:register-schema-for-subject>

Registers a new schema under the specified subject. This operation makes an HTTP POST request to the /subjects/{Subject}/versions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Replace AVRO schema with id

<confluent-schema-registry:replace-avro-schema-with-id>

Replaces an avro schema with a schema ID. This operation replaces the schema in an avro message with an ID from Confluent Schema Registry.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Message

Any

Avro serialized message that contains the schema ID.

#[payload]

Schema ID

Number

Schema used to replace the schema ID in the deserialized message.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INCOMPATIBLE_SCHEMA

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:INVALID_AVRO_MESSAGE

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Replace Id With AVRO Schema

<confluent-schema-registry:replace-id-with-avro-schema>

Replaces an ID with an avro schema.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Message

Any

Avro serialized message that contains the schema ID.

#[payload]

Schema

String

Schema used to replace the schema ID in the deserialized message.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INCOMPATIBLE_SCHEMA

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:INVALID_AVRO_MESSAGE

  • CONFLUENT-SCHEMA-REGISTRY:INVALID_SCHEMA

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Update global config

<confluent-schema-registry:update-global-config>

Updates the global config. This operation makes an HTTP PUT request to the /config endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Update subject config

<confluent-schema-registry:update-subject-config>

Updates the subject config. This operation makes an HTTP PUT request to the /config/{Subject} endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subject

String

Name of the subject.

x

Body

Any

Content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

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]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CONFLUENT-SCHEMA-REGISTRY:BAD_REQUEST

  • CONFLUENT-SCHEMA-REGISTRY:CLIENT_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:CONNECTIVITY

  • CONFLUENT-SCHEMA-REGISTRY:INTERNAL_SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:NOT_FOUND

  • CONFLUENT-SCHEMA-REGISTRY:RETRY_EXHAUSTED

  • CONFLUENT-SCHEMA-REGISTRY:SERVER_ERROR

  • CONFLUENT-SCHEMA-REGISTRY:TIMEOUT

  • CONFLUENT-SCHEMA-REGISTRY:UNAUTHORIZED

Types

Default Header

Headers automatically added to every outbound request.

Field Type Description Default Value Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

Default Query Param

Query parameters automatically added to every outbound request.

Field Type Description Default Value Required

Key

String

Key for this type.

x

Value

String

Value for this type.

x

Proxy

Configures the settings used to connect through a proxy.

Field Type Description Default Value Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

String

TLS

Configures TLS to provide secure communications for the Mule app.

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

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures how to validate certificates.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

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

Password

String

Password used to protect 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.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

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 store used.

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

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

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

Configures a custom OCSP responder for certification revocation checks.

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. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

Allow the deployment to fail.

  • false

Ignore the results of the connectivity test.

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 will run 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 operation 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 the Mule app attempts to reconnect to the remote service or API, in milliseconds.

Blocking

Boolean

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

Expiration Policy

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

Field Type Description Default Value Required

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 for the Max Idle Time field.

HTTP Response Attributes

Field Type Description Default Value Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the 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 memory stream. If the stream data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

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 Buffer Unit 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.