GridGain® is a memory-centric distributed database, caching, and processing platform for transactional, analytical and streaming workloads, delivering in-memory speeds at petabyte scale build on top of Apache Ignite®.

Configurations


Config

GridGain® is a memory-centric distributed database, caching, and processing platform for transactional, analytical and streaming workloads, delivering in-memory speeds at petabyte scale build on top of Apache Ignite®.

Parameters

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 that can be provided to this configuration.

x 

Send Correlation Id

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Whether to specify a correlationId when publishing messages. This applies both for custom correlation ids specifies at the operation level and for default correlation Ids taken from the current event

AUTO

 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Connection

This class provides connection instances and the functionality to disconnect and validate those connections.

Parameters
Name Type Description Default Value Required

Connection Manager

A reference to a global ignite connection manager instance

x 

Reconnection

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

 

Pooling Profile

Characteristics of the connection pool

 

Associated Operations

Operations

AtomicLong - Add and Get

<apache-ignite:atomic-long-add-and-get>

Add and get AtomicLong value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Value to add

Number

Value to add

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicLong - Compare and Set

<apache-ignite:atomic-long-compare-and-set>

Compare and set AtomicLong

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Expected value

Number

Expected value

x 

New value if current value == expected value

Number

New value if current value == expected value

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicLong - Decrement and Get

<apache-ignite:atomic-long-decrement-and-get>

Decrement and get AtomicLong

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicLong - Get

<apache-ignite:atomic-long-get>

Get current AtomicLong value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicLong - Get and Add

<apache-ignite:atomic-long-get-and-add>

Get and add AtomicLong value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Value to add

Number

Value to add

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicLong - Get and Decrement

<apache-ignite:atomic-long-get-and-decrement>

Get and decrement AtomicLong

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicLong - Get and Increment

<apache-ignite:atomic-long-get-and-increment>

Get and increment AtomicLong

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicLong - Get and Set

<apache-ignite:atomic-long-get-and-set>

Set AtomicLong value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Value to set

Number

Value to set

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicLong - Increment and Get

<apache-ignite:atomic-long-increment-and-get>

Increment and get AtomicLong

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Long

String

Atomic object's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicReference - Compare and Set

<apache-ignite:atomic-reference-compare-and-set>

Compare and Set AtomicReference's object

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Reference

String

Atomic object's name

x 

Expected value

Any

x 

New value if current value == expected value

Any

 

Serialize before compare

Boolean

Flag to specify if the value must be serialized before being set

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicReference - Get

<apache-ignite:atomic-reference-get>

Get AtomicReference's object

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Reference

String

Atomic object's name

x 

Deserialize after get

Boolean

Flag to specify if the value must be deserialized after being read

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicReference - Set

<apache-ignite:atomic-reference-set>

Set AtomicReference's object

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Reference

String

Atomic object's name

x 

Value

Any

#[payload]

 

Serialize before set

Boolean

Flag to specify if the value must be serialized before being set

false

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicSequence - Add and Get

<apache-ignite:atomic-sequence-add-and-get>

Add and Get AtomicSequence value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Sequence

String

Atomic object's name

x 

Value to add

Number

Value to add

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicSequence - Get

<apache-ignite:atomic-sequence-get>

Get AtomicSequence value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Sequence

String

Atomic object's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicSequence - Get and Add

<apache-ignite:atomic-sequence-get-and-add>

Get and add AtomicSequence value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Sequence

String

Atomic object's name

x 

Value to add

Number

Value to add

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicSequence - Get and Increment

<apache-ignite:atomic-sequence-get-and-increment>

Get and increment AtomicSequence value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Sequence

String

Atomic object's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicSequence - Increment and Get

<apache-ignite:atomic-sequence-increment-and-get>

Increment and get AtomicSequence value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Sequence

String

Atomic object's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicStamped - Compare and Set

<apache-ignite:atomic-stamped-compare-and-set>

Compare and set AtomicStamped's value and stamp

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Stamped

String

Atomic object's name

x 

Expected value

Any

x 

New value if current value == expected value

Any

#[payload]

 

Expected stamp

Any

x 

New stamp if current stamp == expected stamp

Any

x 

Serialize before compare and set

Boolean

Flag to specify if value and stamp must be serialized before being set

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicStamped - Get stamp

<apache-ignite:atomic-stamped-get-stamp>

Get AtomicStamped's stamp

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Stamped

String

Atomic object's name

x 

Deserialize after get

Boolean

Flag to specify if the stamp must be deserialized after being read

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicStamped - Get Value

<apache-ignite:atomic-stamped-get-value>

Get AtomicStamped's value

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Stamped

String

Atomic object's name

x 

Deserialize after get

Boolean

Flag to specify if the value must be deserialized after being read

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

AtomicStamped - Set

<apache-ignite:atomic-stamped-set>

Set AtomicStamped's value and stamp

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Atomic Stamped

String

Atomic object's name

x 

Value

Any

#[payload]

 

Stamp

Any

 

Serialize before set

Boolean

Flag to specify if value and stamp must be serialized before being set

false

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Clear

<apache-ignite:cache-clear>

Delete all data from cache

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the cache's name

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Contains

<apache-ignite:cache-contains>

Checks if cache contains a key

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the cache's name

x 

Cache entry key

Any

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Get

<apache-ignite:cache-get>

Get entry from cache

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the cache's name

x 

Cache entry key

Any

x 

Deserialize after get

Boolean

flag to specify it the value must be serialized after being get from the cache

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Ingest Data

<apache-ignite:cache-ingest-data>

High speed data ingestion into ignite cache

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the target cache into store data

x 

Data provider

External reference to a com.hawkore.ignite.extensions.api.ingestion.ICacheDataProvider implementation

x 

Number of ingesters

Number

The amount of concurrent ingesters to be placed on the dataProvider. Be careful, dataProvider must be thread-safe if this number is > 1. As the number of ingesters increases, so does the speed on which ingestion process pushes messages into the cache

1

 

Async

Boolean

If true does not wait for ingestion to finish

false

 

Allow Overwrite

Boolean

if true and cache key exists then data will be overwritten

false

 

Batch size

Number

Increase ingestion performance in batch mode by setting a batch size

1000

 

Auto-flush frequency (ms)

Number

If this value is equals or less than 0, autoflush will be disabled and flush will be performed after the ingestion of every batch package

0

 

Serialize before put

Boolean

if data must be serialized before store it

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Instance

<apache-ignite:cache-instance>

Get Ignite Cache

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the cache's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Put

<apache-ignite:cache-put>

Add an entry to a cache

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the cache's name

x 

Cache entry key

Any

x 

Cache entry value

Any

#[payload]

 

Expiry Policy

Enumeration, one of:

  • ACCESSED_EXPIRY_POLICY

  • CREATED_EXPIRY_POLICY

  • MODIFIED_EXPIRY_POLICY

  • TOUCHED_EXPIRY_POLICY

  • ETERNAL_EXPIRY_POLICY

expiry Policy

ACCESSED_EXPIRY_POLICY

 

Entry TTL (⇐0 never expires)

Number

entry TTL %lt;=0 never expires

0

 

Entry TTL unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

entry TTL unit

SECONDS

 

Serialize before put

Boolean

flag to specify it the value must be serialized before being put into the cache

false

 

Async

Boolean

execute operation asynchronously

false

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Remove

<apache-ignite:cache-remove>

Remove an entry from a cache

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the cache's name

x 

Cache entry key

Any

x 

Async

Boolean

execute operation asynchronously

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Replace If Equals

<apache-ignite:cache-replace-if-equals>

Replace entry if equals

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the cache's name

x 

Cache entry key

Any

x 

Cache entry value expected

Any

 

Cache entry value

Any

x 

Serialize before replace

Boolean

flag to specify it the value must be serialized before being put into the cache

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Replace If Exists

<apache-ignite:cache-replace-if-exists>

Replace entry if exists

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

the cache's name

x 

Cache entry key

Any

x 

Cache entry value

Any

#[payload]

 

Serialize before replace

Boolean

flag to specify it the value must be serialized before being put into the cache

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

CountdownLatch - Await

<apache-ignite:countdownlatch-await>

Causes the current thread to wait until the latch has counted down to zero, unless the thread is interrupted, or the specified waiting time elapses.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Countdown latch

String

The name of the countdown latch

x 

Timeout

Number

Max time to wait: timeout < 0 wait forever, timeout = 0 do not wait, timeout > 0 wait the specified time.

60

 

Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

the timeout unit

SECONDS

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

CountdownLatch - Countdown

<apache-ignite:countdownlatch-count-down>

Decrease a countdown latch

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Countdown latch

String

The name of the countdown latch

x 

Amount to decrease

Number

Amount to decrease. -1 all, >0 amount to decrease

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Lock - instance

<apache-ignite:lock-instance>

Return IgniteLock instance

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Lock

String

The name of the Lock

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Query - Lucene

<apache-ignite:query-lucene>

Run TEXT query over only one Query Entity (table) using a lucene expression

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Query entity

String

Table to query, on ignite or SQL format (examples: mycache_myqueryentity, "MyCache".MyQueryEntity

x 

Max results

Number

Maximun entry count at result list

1024

 

Query on local node only

Boolean

If this query should be executed on local node only. Useful if local node is an affinity node (server node)

false

 

Text query

String

Query to execute in lucene format (for example: name: Eva). If not present, results will not be filtered.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Query - SQL

<apache-ignite:query-sql>

Run statement over ignite distributed SQL database

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Query

String

The sql statement. Ignite DML and DDL subset commands are fully supported. Example: select * from "MyCache".MyQueryEntity T where T.oneNumber = ? and T.someText = ? and T.oneDate < ?

x 

Query parameters

Any

List of ordered parameters (?) to replace on sql statement

 

Filters

Array of Filter

List of filters that will be applied with AND restriction to select statement query after, if any, defined statement filters (List of com.hawkore.ignite.extensions.api.query.pagination.Filter)

 

Sorts

Array of Sort

Order by for select statement, will be applied to select statement after, if any, defined order by items (List of com.hawkore.ignite.extensions.api.query.pagination.Sort)

 

Page

Page for select statement (com.hawkore.ignite.extensions.api.query.pagination.Page)

 

Distributed joins allowed

Boolean

Specify if distributed joins are enabled for this query

false

 

Query is over replicated tables only

Boolean

The query contains only replicated tables. This is a hint for potentially more effective execution

false

 

Query is collocated

Boolean

Collocation flag is used for optimization purposes of queries with GROUP BY statements, when data is collocated and you group by collocated key (primary or affinity key)

false

 

Lazy data retrieval

Boolean

By default (lazy=false) Ignite attempts to fetch the whole query result set to memory and send it to the client. For small and medium result sets this to false provides optimal performance and minimize duration of internal database locks, thus increasing concurrency. If resulset is big, use this flag as a hint for Ignite to fetch result set lazily from an iterable collection wrapping an ignite QueryCursor (note that this 'lazy' collection's size will have real size only when underline cursor was fully fetched, so initial size is 0), thus minimizing memory consumption at the cost of moderate performance hit

false

 

Query on local node only

Boolean

If this query should be executed on local node only. Useful if local node is an affinity node (server node)

false

 

Enforce join order

Boolean

Sets flag to enforce join order of tables in the query. If set to true query optimizer will not reorder tables in join. Leave it to false unless you are a SQL expert

false

 

Timeout

Number

Zero value disables timeout. Query will be automatically cancelled if the execution timeout is exceeded

0

 

Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

timeout unit

SECONDS

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Queue - Consume

<apache-ignite:queue-consume>

Pull one message from a queue. If a message is not immediately available, it will wait up to the configured timeout, after which a IgniteModuleError.QUEUE_TIMEOUT error will be thrown.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue

String

the queue configuration

x 

Timeout

Number

Max time to wait: timeout < 0 wait forever, timeout = 0 do not wait, timeout > 0 wait the specified time.

60

 

Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

timeout unit

SECONDS

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations.

Throws

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:QUEUE_TIMEOUT  

  • APACHE-IGNITE:INVALID_PARAMETER  

  • APACHE-IGNITE:EMPTY_QUEUE  

Queue - Ingest Data

<apache-ignite:queue-ingest-data>

High speed data ingestion into IgniteQueue

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue

String

the target queue into store data

x 

Data provider

External reference to a com.hawkore.ignite.extensions.api.ingestion.IQueueDataProvider implementation

x 

Number of ingesters

Number

The amount of concurrent ingesters to be placed on the dataProvider. Be careful, dataProvider must be thread-safe if this number is > 1. As the number of ingesters increases, so does the speed on which ingestion process pushes messages into the queue

1

 

Async

Boolean

If true does not wait for ingestion to finish

false

 

Batch size

Number

Increase ingestion performance in batch mode by setting a batch size

1000

 

Send Correlation Id

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

outbound Correlation Strategy

 

Correlation id

String

Custom correlation Id

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:QUEUE_TIMEOUT  

  • APACHE-IGNITE:INVALID_PARAMETER  

Queue - Instance

<apache-ignite:queue-instance>

Return IgniteQueue instance

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue

String

The queue's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Queue - Publish

<apache-ignite:queue-publish>

Publishes the given item into the queue of the given queue. If the message is not immediately published, it will wait up to the configured timeout, after which a IgniteModuleError.QUEUE_TIMEOUT error will be thrown.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue

String

the queue configuration

x 

Item to publish

Any

x 

Timeout

Number

Max time to wait: timeout < 0 wait forever, timeout = 0 do not wait, timeout > 0 wait the specified time.

60

 

Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

timeout unit

SECONDS

 

Send Correlation Id

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

options on whether to include an outbound correlation id or not

 

Correlation id

String

allows to set a custom correlation id

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:QUEUE_TIMEOUT  

  • APACHE-IGNITE:INVALID_PARAMETER  

Queue - Publish and Consume

<apache-ignite:queue-publish-consume>

Publishes the given item into a queue, and then awaits up to the timeout for a response to be supplied on a temporal reply-To artifact that this operation automatically creates.

The temporal reply artifact is automatically disposed after a response is received or the timeout expires.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue

String

the queue configuration

x 

Item to publish

Any

x 

Timeout

Number

Max time to wait: timeout < 0 wait forever, timeout = 0 do not wait, timeout > 0 wait the specified time.

60

 

Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

timeout unit

SECONDS

 

Send Correlation Id

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

options on whether to include an outbound correlation id or not

 

Correlation id

String

allows to set a custom correlation id

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations.

Throws

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:QUEUE_TIMEOUT  

  • APACHE-IGNITE:INVALID_PARAMETER  

Scheduler - Reschedule

<apache-ignite:scheduler-reschedule>

Reschedule task on scheduler

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Scheduler task id

String

task identifier (a.k.a. uuid from scheduler id)

x 

Enabled on start

Boolean

if scheduler is enabled on flow start. If false, manual activation will be required throught 'Scheduler - start' operation

true

 

Allow concurrent execution

Boolean

if enabled, same flow will be run on all cluster nodes at scheduled time

false

 

Scheduler strategy

scheduler strategy

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Scheduler - Task’s Executions

<apache-ignite:scheduler-run-list>

List of scheduler task's executions

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Scheduler task id

String

task identifier (a.k.a. uuid from scheduler id)

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Scheduler - Run Now

<apache-ignite:scheduler-run-now>

Run scheduler task

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Scheduler task id

String

task identifier (a.k.a. uuid from scheduler id)

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Scheduler - Start

<apache-ignite:scheduler-start>

Start scheduler

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Scheduler task id

String

task identifier (a.k.a. uuid from scheduler id)

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Scheduler - Stop

<apache-ignite:scheduler-stop>

Stop scheduler

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Scheduler task id

String

task identifier (a.k.a. uuid from scheduler id)

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Scheduler - Task Configurations

<apache-ignite:scheduler-tasks>

Get Scheduler tasks info

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Semaphore - Acquire Permits

<apache-ignite:semaphore-acquire-permits>

Acquire permits from semaphore

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Semaphore

String

semaphore's name

x 

Permits to acquire

Number

permits to acquire, must be greater than zero

x 

Timeout

Number

Max time to wait: timeout < 0 wait forever, timeout = 0 do not wait, timeout > 0 wait the specified time.

60

 

Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

timeout unit

SECONDS

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Semaphore - Drain Permits

<apache-ignite:semaphore-drain-permits>

Acquire all permits immediately available from a semaphore

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Semaphore

String

semaphore's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Number

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Semaphore - Instance

<apache-ignite:semaphore-instance>

Gets semaphore

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Semaphore

String

semaphore's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Semaphore - Release Permits

<apache-ignite:semaphore-release-permits>

Release permits from semaphore

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Semaphore

String

semaphore's name

x 

Permits to release

Number

number of permits to release

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Semaphore - Reset Permits

<apache-ignite:semaphore-reset-permits>

Reset semaphore permits

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Semaphore

String

semaphore's name

x 

Permits to set

Number

number of permits to (re)set

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Set - Add

<apache-ignite:set-add>

Add an item to set

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Set

String

the Set's name

x 

Item

Any

x 

Serialize before add

Boolean

flag to specify if the item must be serialized before being added to the set

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Set - Clear

<apache-ignite:set-clear>

Clear the given Set

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Set

String

the Set's name

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Set - Contains

<apache-ignite:set-contains>

Checks if set contains item

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Set

String

the Set's name

x 

Item

Any

x 

Serialize before contains

Boolean

flag to specify if the item must be serialized before being searched at the set

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Set - Instance

<apache-ignite:set-instance>

Get Set instance

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Set

String

the Set's name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Set - Iterator

<apache-ignite:set-iterator>

Stream over IgniteSet values

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Set

String

the Set's name

x 

Deserialize stream

Boolean

flag to specify if the item must be deserialized after being retrieved from the set

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Set - Remove

<apache-ignite:set-remove>

Remove an item form set

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Set

String

the Set's name

x 

Item

Any

x 

Serialize before remove

Boolean

flag to specify if the item must be serialized before being searched at the set

false

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Topic - Publish

<apache-ignite:topic-publish>

Topic Based Messaging send

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Topic

String

the topic name

x 

Item to publish

Any

#[payload]

 

Subscribers to send

Enumeration, one of:

  • ANY

  • LOCAL_ONLY

  • REMOTE_ONLY

send message only to this subscribers @see IgniteMessagingSubscribersGroup

ANY

 

Send Correlation Id

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

options on whether to include an outbound correlation id or not

 

Correlation id

String

allows to set a custom correlation id

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Utils - Ignite Instance

<apache-ignite:utils-ignite-instance>

Ignite instance

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Utils - Node Consistent Id

<apache-ignite:utils-node-consistent-id>

Get current node consistentId

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:RETRY_EXHAUSTED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:CONNECTIVITY  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Batch - Batch

<apache-ignite:batch>

Batch processor, batch messages will be executed by any mule instance at the cluster with this flow deployed.

Parameters

Name Type Description Default Value Required

Batch content

Any

Batch entry array/collection/iterator

#[payload]

 

Batch strategy

A reference to a global ignite Batch scope strategy instance

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Attributes Type

Any

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Batch - Batch Input

<apache-ignite:batch-input>

Batch input processor, this is not intended to be used directly.

Parameters

Name Type Description Default Value Required

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Any

Attributes Type

Any

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Batch - Batch On Complete

<apache-ignite:batch-on-complete>

Batch On Complete processor, this is not intended to be used directly.

Parameters

Name Type Description Default Value Required

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Any

Attributes Type

Any

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Batch - Batch Step

<apache-ignite:batch-step>

Batch Step processor, this is not intended to be used directly.

Parameters

Name Type Description Default Value Required

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Any

Attributes Type

Any

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Cache - Scope

<apache-ignite:cache-scope>

Caches a processor chain execution response

Its required that chain execution response was Serializable. Only response (payload) will be cached.

Parameters

Name Type Description Default Value Required

Filter expression

Any

Exclude messages from caching when filter expression is evaluated to true

 

Key expression

Any

x 

Strategy ref

A reference to a global ignite Cache scope strategy instance

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Any

Attributes Type

Any

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Lock - Scope

<apache-ignite:lock-scope>

Acquires a distributed lock if it is free within the given waiting time and, after chain execution, frees it

Parameters

Name Type Description Default Value Required

Lock

String

The name of the Lock

x 

Timeout

Number

Max time to wait: timeout < 0 wait forever, timeout = 0 do not wait, timeout > 0 wait the specified time.

60

 

Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

timeout unit

SECONDS

 

Connection manager

A reference to a global ignite connection manager instance

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Any

Attributes Type

Any

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Transactional - scope

<apache-ignite:transactional-scope>

Creates a transactional scope for ignite cache operations

Parameters

Name Type Description Default Value Required

Transaction concurrency

Enumeration, one of:

  • OPTIMISTIC

  • PESSIMISTIC

transaction concurrency configuration, by default PESSIMISTIC will be used

PESSIMISTIC

 

Transaction isolation

Enumeration, one of:

  • READ_COMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

transaction isolation configuration, by default PESSIMISTIC will be used

REPEATABLE_READ

 

Transaction timeout millis (0 disabled)

Number

transaction timeout millis (0 to disable transaction timeout)

0

 

Number of entries in transaction

Number

number of entries participating in transaction (may be approximate)

0

 

Connection manager

A reference to a global ignite connection manager instance

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Any

Attributes Type

Any

Throws

  • APACHE-IGNITE:OBJECT_CREATION_ERRORD  

  • APACHE-IGNITE:OBJECT_DUPLICATED  

  • APACHE-IGNITE:NO_SERIALIZABLE  

  • APACHE-IGNITE:OBJECT_NOT_FOUND  

  • APACHE-IGNITE:OPERATION_ERROR  

  • APACHE-IGNITE:INCOMPATIBLE_CONFIG  

  • APACHE-IGNITE:INVALID_PARAMETER  

Sources

Event - Cache entry events listener

<apache-ignite:cache-event-listener>

A source which monitors data modifications occurring on Ignite caches. Once IgniteCacheEventListener is started, you will get notified of all the data changes.

See org.apache.ignite.cache.query.ContinuousQuery for more information.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Cache

String

x 

Allow concurrent execution

Boolean

When enabled, this flow identified by its name will be run on all clustered application instances when cache entry event is received

false

 

Deserialize values after reveive cache event

Boolean

false

 

Sets the flag value defining whether to notify about EventType.EXPIRED events. If true, then the remote listener will get notifications about entries expired in cache. Otherwise, only EventType.CREATED, EventType.UPDATED and EventType.REMOVED events will be fired in the remote listener

Boolean

false

 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when runnning in Cluster

 

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

For Configurations.

Event - Ignite events listener

<apache-ignite:ignite-event-listener>

A source which listens for local Ignite events. Once IgniteEventListener is started, you will get notified of all subscribed events.

See org.apache.ignite.IgniteEvents for more information.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Events to subscribe to

String

Comma separated list of Ignite events to subscribe to. See org.apache.ignite.events.EventType for supported 'named' values, example 'EVT_CACHE_ENTRY_CREATED, EVT_CACHE_OBJECT_PUT'. Integer event types are also supported.

x 

Allow concurrent execution

Boolean

When enabled, this flow identified by its name will be run on all clustered application instances when event is received

false

 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when runnning in Cluster

 

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

For Configurations.

Queue - listener

<apache-ignite:queue-listener>

A source which listens on an Ignite Queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue

String

The queue name

x 

Timeout

Number

How long to wait

60

 

Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A TimeUnit which qualifies the #timeoutUnit

SECONDS

 

Number of consumers

Number

The amount of concurrent consumers to be placed on the queue. As the number of consumers increases, so does the speed on which this source pushes messages into the owning flow.

4

 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when runnning in Cluster

 

Redelivery Policy

Defines a policy for processing the redelivery of the same message

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Content

Any

The content to send to the reply-To queue. Will only be used and evaluated if the message got into the queue through the apache-ignite:queue-publish-consume operation

#[payload]

 

Output

Type

Any

Attributes Type

For Configurations.

Scheduler - source

<apache-ignite:scheduler-source>

This connector provides a rich API for working with Ignite Cron-Based Scheduling

Cron Syntax

Cron Syntax
. - - - - - minute (0-59)
| . - - - - hour (0-23)
| | . - - - day of month (1-31)
| | | . - - month (1-12) or jan,feb,mar,apr,may,jun,jul...
| | | | . - week day (0-6) (sunday=0 or 7) or sun,mon,tue,wed,thu,fri,sat
| | | | |
* * * * *
Cron Syntax Extension

Ignite introduces an extension to Cron syntax, which allows to specify an initial delay in seconds and a number of runs. These two optional numbers go in curly braces, comma-separated, before the Cron specification. An example below specifies execution 5 times each minute with an initial 2 seconds delay.

 {2, 5} * * * * * 

NOTE: In current implementation, Cron shorthands (@hourly, @daily, @weekly...) are not supported and a minimal scheduling time unit is 1 minute.

Install ignite-scheduler module

The ignite-scheduler module have LGPL dependencies and therefore can't be deployed on Maven Central repository. To use this module, you will need to build it from sources manually and add it to your project

For more info visit lgpl-dependencies

For more info about cron based scheduling visit cron- based-scheduling.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Description

String

User friendly description for scheduler tasks management, should be unique

x 

Enabled on start

Boolean

Whether scheduler is enabled on flow startup. When false, manual activation will be required throught 'Scheduler - start' operation

true

 

Allow concurrent execution

Boolean

When enabled, this flow identified by its name will be run on all clustered application instances at scheduled time

false

 

Scheduler strategy

x 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when runnning in Cluster

 

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

Any

For Configurations.

Topic - listener

<apache-ignite:topic-listener>

A source which listens for messages on an Ignite Topic.

See org.apache.ignite.IgniteMessaging for more information.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Topic

String

x 

Allow concurrent execution

Boolean

When enabled, this flow identified by its name will be run on all clustered application instances when topic message is received

false

 

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when runnning in Cluster

 

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

Any

Attributes Type

For Configurations.

Types

Connection Manager

Field Type Description Default Value Required

Ignite Instance Name

String

An Ignite instance registered with this name on local JVM. If this parameter is set, then ignite spring configuration file parameter will be ignored if this instance effectively exists, otherwise will be used as Ignite instance name overwritting configuration file ignite instance name

Ignite Spring Cfg File

String

Ignite spring configuration file. Optional if igniteInstanceName exists

Connect To Remote Cluster

Boolean

While developing, if this flag is enabled, connection will be stablished to remote cluster as client, otherwise local JVM server node will be created for testing purposes. Default false

false

Cache Defs

Array of Cache Def

The caches that this config owns

Set Defs

Array of Set Def

The sets that this config owns

Queue Defs

Array of Queue Def

The queues that this config owns

Topic Defs

Array of Topic Def

The topics that this config owns

Atomic Long Defs

Array of Atomic Long Def

The atomic longs that this config owns

Atomic Reference Defs

The atomic references that this config owns

Atomic Sequence Defs

The atomic sequences that this config owns

Atomic Stamped Defs

The atomic stampedes that this config owns

Lock Defs

Array of Lock Def

The locks that this config owns

Semaphore Defs

Array of Semaphore Def

The semaphores that this config owns

Countdownlatch Defs

The count down latches that this config owns

Cache Def

Field Type Description Default Value Required

Cache Name

String

x

Cache Config

x

Set Def

Field Type Description Default Value Required

Set Name

String

x

Collection Config

x

Queue Def

Field Type Description Default Value Required

Queue Name

String

x

Capacity

Number

0

Collection Config

x

Topic Def

Field Type Description Default Value Required

Topic Name

String

x

Atomic Long Def

Field Type Description Default Value Required

Initial Value

Number

0

Atomic Name

String

x

Create

Boolean

true

Atomic Config

x

Atomic Reference Def

Field Type Description Default Value Required

Atomic Name

String

x

Create

Boolean

true

Atomic Config

x

Atomic Sequence Def

Field Type Description Default Value Required

Initial Value

Number

0

Atomic Name

String

x

Create

Boolean

true

Atomic Config

x

Atomic Stamped Def

Field Type Description Default Value Required

Atomic Name

String

x

Create

Boolean

true

Atomic Config

x

Lock Def

Field Type Description Default Value Required

Lock Name

String

x

Fair

Boolean

true

Failover Safe

Boolean

true

Create

Boolean

true

Semaphore Def

Field Type Description Default Value Required

Semaphore Name

String

x

Count

Number

x

Fair

Boolean

true

Create

Boolean

true

Countdownlatch Def

Field Type Description Default Value Required

Countdown Latch Name

String

x

Count

Number

x

Autodelete

Boolean

false

Create

Boolean

true

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 will fail 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 ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)

Disabled

Boolean

Whether pooling should be disabled

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

Cache Entry Event

Field Type Description Default Value Required

Cache

String

Event Type

Enumeration, one of:

  • CREATED

  • UPDATED

  • REMOVED

  • EXPIRED

Key

Any

Old Value

Any

Old Value Available

Boolean

Original Event

Any

Value

Any

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

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

Ignite Event

Field Type Description Default Value Required

Id

String

Message

String

Name

String

Node

String

Original Event

Any

Short Display

String

Timestamp

Number

Type

Number

Queue Message Attributes

Field Type Description Default Value Required

Correlation Id

String

Queue Name

String

Timestamp

DateTime

Topic Message Attributes

Field Type Description Default Value Required

Correlation Id

String

Sender Node UUID

Any

Timestamp

DateTime

Topic Name

String

Ingestion Result

Field Type Description Default Value Required

Elapsed Time

Number

Estimated Data To Process

Number

Finished

Boolean

Partial Elapsed Time

Number

Partial Sent

Number

Processed

Number

Progress

Number

Sent

Number

Viable Data Percent

Number

Filter

Field Type Description Default Value Required

Filter Value

Any

Operator

String

Property

String

Sort

Field Type Description Default Value Required

Direction

Enumeration, one of:

  • ASC

  • DESC

Property

String

Page

Field Type Description Default Value Required

Page Number

Number

Page Size

Number

Batch Instance

Field Type Description Default Value Required

Message Count

Number

Uid

String

Batch Scope Strategy

Field Type Description Default Value Required

Manager Ref

x

Cache Def

x

Collection Config

x

Cache Scope Strategy

Field Type Description Default Value Required

Expiry Policy

Enumeration, one of:

  • ACCESSED_EXPIRY_POLICY

  • CREATED_EXPIRY_POLICY

  • MODIFIED_EXPIRY_POLICY

  • TOUCHED_EXPIRY_POLICY

  • ETERNAL_EXPIRY_POLICY

CREATED_EXPIRY_POLICY

Entry TTL

Number

0

Entry TTL Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

SECONDS

Cache Def

x

Manager Ref

x

Fixed Frequency

Field Type Description Default Value Required

Frequency

Number

1000

Start Delay

Number

1000

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

MILLISECONDS

Cron

Field Type Description Default Value Required

Cron Expression

String

* * * * *

Bean Reference Atomic Config

Field Type Description Default Value Required

Bean Ref

String

x

Simple Atomic Configuration

Field Type Description Default Value Required

Cache Mode

Enumeration, one of:

  • LOCAL

  • REPLICATED

  • PARTITIONED

Group Name

String

Backups

Number

0

Bean Reference Cache Config

Field Type Description Default Value Required

Bean Ref

String

x

Simple Cache Configuration

Field Type Description Default Value Required

Cache Mode

Enumeration, one of:

  • LOCAL

  • REPLICATED

  • PARTITIONED

Atomicity Mode

Enumeration, one of:

  • TRANSACTIONAL

  • ATOMIC

  • TRANSACTIONAL_SNAPSHOT

Write Synchronization Mode

Enumeration, one of:

  • FULL_SYNC

  • FULL_ASYNC

  • PRIMARY_SYNC

Backups

Number

0

Data Region Name

String

Group Name

String

On Heap Cache Eviction Policy

Client Near Cache Eviction Policy

Server Near Cache Eviction Policy

Eviction Policy Cache Configuration

Field Type Description Default Value Required

Max Size

Number

0

Max Mem Size

Number

0

Batch Size

Number

1

Eviction Policy

Enumeration, one of:

  • FIFO_EVICTION_POLICY

  • SORTED_EVICTION_POLICY

  • LRU_EVICTION_POLICY

Bean Reference Collection Config

Field Type Description Default Value Required

Bean Ref

String

x

Simple Collection Configuration

Field Type Description Default Value Required

Cache Mode

Enumeration, one of:

  • LOCAL

  • REPLICATED

  • PARTITIONED

Atomicity Mode

Enumeration, one of:

  • TRANSACTIONAL

  • ATOMIC

  • TRANSACTIONAL_SNAPSHOT

Group Name

String

Backups

Number

0

Collocated

Boolean

false

Ignite Artifact Wrapper

Field Type Description Default Value Required

Delegate

Any

Queue Message

Field Type Description Default Value Required

Correlation Id

String

Value

Any

Scheduler Task Config

Field Type Description Default Value Required

Active On Start

Boolean

Concurrency Allowed

Boolean

Cron Expression

String

Description

String

Frequency

Number

Id

String

Location

String

Start Delay

Number

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS