Contact Us 1-800-596-4880
  1. Homepage
  2. Redis Connector (5.4)

  3. Redis Connector Reference

All Connectors

Redis Connector 5.4 Reference - Mule 4

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.
You can set configurations in Expression mode, except when Redis Connector is used in conjunction with Object Store Connector, which does not support Expression mode.

Starting with Redis Connector 5.4.5, Mule apps that use an Object Store Entry TTL exceeding 24 days now observe that the TTL for new keys is set to the correct values.

Redis Configuration

Name Type Description Default Value Required

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

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. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Redis Connector supports only password-based authentication. Redis Connector does not currently support Role-Based Access Control (RBAC).

Clustered

Redis Connector does not support clustered connections on Redis Enterprise Active-Active databases. To connect to one of the Redis Enterprise active-active clusters, non-clustered connection should be used in the connector. However, the connection is only made to the specified node.

Redis Connector does not support clustered sharded connections.

Parameters

Name Type Description Default Value Required

Endpoint identification algorithm

Enumeration, one of:

  • HTTPS

  • LDAPS

  • DISABLED

The endpoint identification algorithm used by clients to validate the server hostname. The default value is an empty string, which means that this functionality is disabled. Clients, including client connections created by the broker for inter-broker communication, verify that the broker hostname matches the hostname in the broker’s certificate.

DISABLED

TLS Configuration

TLS

Configures TLS. If you are running the Mule app securely by using the HTTPS protocol, you must configure TLS in the connector.

Max Total

Number

Maximum number of connections that can be in the pool at a given time

8

Max Idle

Number

Maximum number of idle connections allowed in a pool before the connections are closed

8

Min Idle

Number

Minimum number of idle connections in the pool that are ready for immediate use

0

Lifo

Boolean

If set to true, the queue is last-in first-out

true

Fairness

Boolean

If set to true, the thread that waited for the longest amount of time to connect acquires the next available connection

false

Max Wait Millis

Number

Maximum number of milliseconds the client can wait before a connection is available

-1

Min Evictable Idle Time Millis

Number

Minimum amount of time a connection can be idle in the pool before it is evicted

1800000

Soft Min Evictable Idle Time Millis

Number

Minimum amount of time a connection can be idle in pool before it is evicted

1800000

Num Tests Per Eviction Run

Number

Number of connections to test per eviction attempt

3

Test On Create

Boolean

Whether to test the validity of the connection

false

Test On Borrow

Boolean

Whether to test the validity of the connection before it is borrowed from the pool

false

Test On Return

Boolean

Whether to test the validity of the connection before it is returned from the pool

false

Test While Idle

Boolean

Whether to enable idle resource detection

false

Time Between Eviction Runs Millis

Number

Cycle of time for idle resources detection

-1

Block When Exhausted

Boolean

Whether the client waits when the resource pool is exhausted

true

Jmx Enabled

Boolean

Enables JMX monitoring when set to true

true

Jmx Name Prefix

String

JMX name prefix used as part of the name assigned to the JMX-enabled pool

pool

Jmx Name Base

String

JMX name base used as part of the name assigned to the JMX-enabled pool

Connection Timeout

Number

Redis instance Connection timeout value.

2000

Connection Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Redis instance connection timeout.

MILLISECONDS

Password

String

Redis password. Set if the server requires authentication.

Entry TTL

Number

The default time to live to set on keys stored for the connector.

Cluster Hosts

String

Redis cluster hosts separated by commas and having the format host:port. Use this field when you want to access your Redis cluster through the connector.

x

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.

NonClustered

Parameters

Name Type Description Default Value Required

Endpoint identification algorithm

Enumeration, one of:

  • HTTPS

  • LDAPS

  • DISABLED

The endpoint identification algorithm used by clients to validate the server hostname. The default value is an empty string, which means that this functionality is disabled. Clients, including client connections created by the broker for inter-broker communication, verify that the broker hostname matches the hostname in the broker’s certificate.

DISABLED

TLS Configuration

TLS

Configures TLS. If you are running the Mule app securely by using the HTTPS protocol, you must configure TLS in the connector.

Max Total

Number

Maximum number of connections that can be in the pool at a given time

8

Max Idle

Number

Maximum number of idle connections allowed in a pool before the connections are closed

8

Min Idle

Number

Minimum number of idle connections in the pool that are ready for immediate use

0

Lifo

Boolean

If set to true, the queue is last-in first-out

true

Fairness

Boolean

If set to true, the thread that waited for the longest amount of time to connect acquires the next available connection

false

Max Wait Millis

Number

Maximum number of milliseconds the client can wait before a connection is available

-1

Min Evictable Idle Time Millis

Number

Minimum amount of time a connection can be idle in the pool before it is evicted

1800000

Soft Min Evictable Idle Time Millis

Number

Minimum amount of time a connection can be idle in pool before it is evicted

1800000

Num Tests Per Eviction Run

Number

Number of connections to test per eviction attempt

3

Test On Create

Boolean

Whether to test the validity of the connection

false

Test On Borrow

Boolean

Whether to test the validity of the connection before it is borrowed from the pool

false

Test On Return

Boolean

Whether to test the validity of the connection before it is returned from the pool

false

Test While Idle

Boolean

Whether to enable idle resource detection

false

Time Between Eviction Runs Millis

Number

Cycle of time for idle resources detection

-1

Block When Exhausted

Boolean

Whether the client waits when the resource pool is exhausted

true

Jmx Enabled

Boolean

Enables JMX monitoring when set to true

true

Jmx Name Prefix

String

JMX name prefix used as part of the name assigned to the JMX-enabled pool

pool

Jmx Name Base

String

JMX name base used as part of the name assigned to the JMX-enabled pool

Connection Timeout

Number

Redis instance Connection timeout value.

2000

Connection Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Redis instance connection timeout.

MILLISECONDS

Password

String

Redis password. Set this if the server requires authentication.

Entry TTL

Number

The default time to live to be set on keys stored for the connector.

Host

String

Redis host. Use this field when you want to access you Redis server that is not part of a cluster through connector.

localhost

Port

Number

Redis port. The port on which your non cluster server is running.

6379

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.

Sentinel

Sentinel provides a high-availability solution in case of failure on your Redis cluster.

Parameters

Name Type Description Default Value Required

Max Total

Number

Maximum number of connections that can be in the pool at a given time

8

Max Idle

Number

Maximum number of idle connections allowed in a pool before the connections are closed

8

Min Idle

Number

Minimum number of idle connections in the pool that are ready for immediate use

0

Lifo

Boolean

If set to true, the queue is last-in first-out

true

Fairness

Boolean

If set to true, the thread that waited for the longest amount of time to connect acquires the next available connection

false

Max Wait Millis

Number

Maximum number of milliseconds the client can wait before a connection is available

-1

Min Evictable Idle Time Millis

Number

Minimum amount of time a connection can be idle in the pool before it is evicted

1800000

Soft Min Evictable Idle Time Millis

Number

Minimum amount of time a connection can be idle in pool before it is evicted

1800000

Num Tests Per Eviction Run

Number

Number of connections to test per eviction attempt

3

Test On Create

Boolean

Whether to test the validity of the connection

false

Test On Borrow

Boolean

Whether to test the validity of the connection before it is borrowed from the pool

false

Test On Return

Boolean

Whether to test the validity of the connection before it is returned from the pool

false

Test While Idle

Boolean

Whether to enable idle resource detection

false

Time Between Eviction Runs Millis

Number

Cycle of time for idle resources detection

-1

Block When Exhausted

Boolean

Whether the client waits when the resource pool is exhausted

true

Jmx Enabled

Boolean

Enables JMX monitoring when set to true

true

Jmx Name Prefix

String

JMX name prefix used as part of the name assigned to the JMX-enabled pool

pool

Jmx Name Base

String

JMX name base used as part of the name assigned to the JMX-enabled pool

Connection Timeout

Number

Redis instance connection timeout value.

2000

Connection Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Redis instance connection timeout.

MILLISECONDS

Password

String

Redis password. Set this if the server requires authentication.

Entry TTL

Number

The default time to live to be set on keys stored for the connector.

Sentinels Hosts

String

Set of sentinel addresses that are monitoring the master host to which the connector will connect.

x

Master Name

String

Redis master name. The name of the master for which the sentinels will return the current address.

Sentinel Password

String

Sentinel password. Set this if the sentinel servers require authentication.

Index

Number

The index of the database that the pool will use.

Sentinel Connection Timeout

Number

Sentinel connection timeout value.

2000

Sentinel Connection Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for sentinel connection timeout.

MILLISECONDS

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.

Sources

Supported source:

Subscribe

<redis:subscribe>

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Channels

Array of String

A list of channel names or globbing patterns.

x

Output Mime Type

String

The MIME type of the payload that this source outputs.

Primary Node Only

Boolean

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

Streaming Strategy

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

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Subscribe Channel Attributes

For Configurations

Operations

Supported operations:

Add To Set

<redis:add-to-set>

Add the message payload to the set stored at the specified key. If the key does not exist, a new key holding a set is created.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for SADD

x

Value

String

The value to set.

#[payload]

Must Succeed

Boolean

If true, ensures that adding to the set is successful (that is, no pre-existing identical value is in the set)

false

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Add To Sorted Set

<redis:add-to-sorted-set>

Add the message payload with the desired score to the sorted set stored at the specified key. If the key does not exist, a new key holding a sorted set is created.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for ZADD

x

Value

String

The value to set.

#[payload]

Score

Number

Score to use for the value

x

Must Succeed

Boolean

If true, ensures that adding to the set is successful (that is, no pre-existing identical value is in the set)

false

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Decrement

<redis:decrement>

Decrements the number stored at key by step. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains data that cannot be represented as integer.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for DECR.

x

Step

Number

Step used for the increment.

1

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Del

<redis:del>

Remove the specified key, if it exists.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for DEL

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Exists

<redis:exists>

Test if the specified key exists.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for EXISTS

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Expire

<redis:expire>

Set a timeout on the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

The key in the sorted set.

x

Seconds

Number

The time to live in seconds.

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Expire At

<redis:expire-at>

Set a timeout in the form of a UNIX timestamp (number of seconds elapsed since 1 Jan 1970) on the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

The key in the sorted set.

x

Unix Time

Number

The UNIX timestamp in seconds.

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Get

<redis:get>

Get the value of the specified key. If the key does not exist, a null value is returned.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for GET

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Get All From Hash

<redis:get-all-from-hash>

Get all fields and values of the hash stored at the specified key. If the field or the hash don’t exist, a null value is returned.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for HGETALL

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Get From Hash

<redis:get-from-hash>

Get the value stored at the specified field in the hash at the specified key. If the field or the hash don’t exist, a null value is returned.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for HGET

x

Field

String

Field to use for HGET

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Get Range By Index

<redis:get-range-by-index>

Retrieve a range of values from the sorted set stored at the specified key. The range of values is defined by indices in the sorted set and sorted as desired.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for ZRANGE/ZREVRANGE

x

Start

Number

Range start index

x

End

Number

Range end index

x

Ascending Order

Boolean

Index order for sorting the range. If the parameter is set to true, the range is sorted in ascending order. If the parameter is set to false, the range is sorted in descending order.

true

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Get Range By Score

<redis:get-range-by-score>

Retrieve a range of values from the sorted set stored at the specified key. The range of values is defined by scores in the sorted set and sorted as desired.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for ZRANGEBYSCORE and ZREVRANGEBYSCORE

x

Min

Number

Range start score

x

Max

Number

Range end score

x

Ascending Order

Boolean

Score order for sorting the range. If the parameter is set to true, the range is sorted in ascending order. If the parameter is set to false, the range is sorted in descending order.

true

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Get TTL

<redis:get-ttl>

Get the remaining time to live of a volatile key, in seconds.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

The key in the sorted set.

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Increment

<redis:increment>

Increments the number stored at key by step. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains data that can not be represented as integer.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for INCR.

x

Step

Number

Step used for the increment.

1

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Increment Hash

<redis:increment-hash>

Increments the number stored at field in the hash stored at key by increment. If the key does not exist, a new key holding a hash is created. If field does not exist, the value is set to 0 before the operation is performed.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for HGET

x

Field

String

Field to use for HGET

x

Step

Number

Step used for the increment.

1

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Increment Sorted Set

<redis:increment-sorted-set>

Increments the score of member in the sorted set stored at key by increment. If member does not exist in the sorted set, it is added with increment as its score (as if its previous score was 0.0). If the key does not exist, a new sorted set with the specified member as its sole member is created.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

The key in the sorted set.

x

Value

String

The value to set.

#[payload]

Step

Number

The step to use to increment the score.

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Persist

<redis:persist>

Undo an expire or expireAt, turning the volatile key into a normal key.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

The key in the sorted set.

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Pop From List

<redis:pop-from-list>

Pop a value from the desired side of the list stored at the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for LPOP/RPOP

x

Pop Left

boolean

The side from which to pop the value. If the parameter is true, the value is popped from the left side. If the parameter is false, the value is popped from the right side.

false

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Pop From Set

<redis:pop-from-set>

Pops a random value from the set stored at the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for SPOP

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Publish

<redis:publish>

Publish the message payload to the specified channel.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Channel

String

Destination of the published message

x

Message

String

The message to publish.

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Push To List

<redis:push-to-list>

Push the message payload to the desired side (LEFT or RIGHT) of the list stored at the specified key. If the key does not exist, a new key holding a list is created as long as ifExists is false.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for LPUSH or RPUSH, or LPUSHX or RPUSHX.

x

Value

String

The value to push.

#[payload]

Push Left

Boolean

Side that receives the pushed payload. If the parameter is true, push the payload on the left side. If the parameter is false, push the payload on the right side.

false

If Exists

Boolean

If the parameter is true, execute LPUSHX or RPUSHX. If the parameter is false, execute LPUSH or RPUSH.

false

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Random Member From Set

<redis:random-member-from-set>

Reads a random value from the set stored at the specified key.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for SRANDMEMBER

x

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Range From List

<redis:range-from-list>

Returns the specified range of elements from an existing list.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key of the list from which to return elements

x

start

String

Zero-based index at which the range starts. A negative value indicates that the offset starts at the end of the list.

x

stop

String

Zero-based index at which the range ends. A negative value indicates that the offset starts at the end of the list.

x

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Set

<redis:set>

Set the key to hold the payload. If the key already holds a value, it is overwritten, regardless of its type as long as ifNotExists is false.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key used to store payload

x

Value

String

The value to set.

#[payload]

Expire

Number

Set a timeout on the specified key in seconds. After the timeout the key is automatically deleted by the server. A key with an associated timeout is said to be volatile in Redis terminology.

If Not Exists

Boolean

If true, then execute SETNX on the Redis server, otherwise execute SET.

false

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Set In Hash

<redis:set-in-hash>

Set the specified hash field to the message payload. If the key does not exist, a new key holding a hash is created as long as ifNotExists is true.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key to use for HSET

x

Value

String

The value to set.

#[payload]

Field

String

Field to use for HSET

If Not Exists

Boolean

If true execute HSETNX, otherwise HSET.

false

Target Variable

String

Name of a variable that stores the operation’s output

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Trim From List

<redis:trim-from-list>

Modify an existing list so that it contains only the specified range of elements.

Parameters

Name Type Description Default Value Required

Configuration

String

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

x

Key

String

Key of the list to modify

x

start

String

Zero-based index at which the range starts. A negative value indicates that the offset starts at the end of the list.

x

stop

String

Zero-based index at which the range ends. A negative value indicates that the offset starts at the end of the list.

x

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • REDIS:CONNECTIVITY

  • REDIS:INVALID_REQUEST_DATA

  • REDIS:INVALID_CONFIGURATION

  • REDIS:INVALID_STRUCTURE_FOR_INPUT_DATA

  • REDIS:RETRY_EXHAUSTED

  • REDIS:UNKNOWN

  • REDIS:UNABLE_TO_UNSUBSCRIBE

Types

TLS

Field Type Description Default Value Required

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

Truststore

Key Store

Keystore

Revocation Check

Truststore

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

The password used to protect the truststore.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

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

Keystore

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 keystore.

Type

String

The type of store used.

Alias

String

When the keystore 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 keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

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

Field Type Description Default Value Required

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

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

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

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

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

A time unit that qualifies the maxIdleTime attribute

Subscribe Channel Attributes

Field Type Description Default Value Required

Channel

String

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size will be expanded 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

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

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Non-repeatable Stream

Disables the repeatable stream functionality and use non-repeatable streams to have less performance overhead, memory use, and cost.

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

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

Message Digest Algorithm

String

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

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is going to be stored.

See Also

Back to top
View on GitHub