redis connector

Description - Removes and returns one or more random elements from the set value store at key.

Runtime Class - com.ibi.agents.XDRedisSetsSPop



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the set is stored at.
*Count:integerThe number of value(s) to pop from the set.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Return all the members (elements) of the set value stored at key.

Runtime Class - com.ibi.agents.XDRedisSetsSMembers



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the set is stored at.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Adds all the specified members with the specified scores to the sorted set stored at key. It is possible to specify multiple score / member pairs. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.

Runtime Class - com.ibi.agents.XDRedisSortedSetsZAdd



Parameter Groups

 ParameterTypeDescription
*Key:stringThe key associated with the set.
*Member:stringA value to be stored in the set
*Score:stringA value associated with each member used to sort the set from smallest to greatest. While members are unique, scores may be repeated.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Set a new value as the element at index position of the List at key.

Runtime Class - com.ibi.agents.XDRedisListsSet



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the list is stored at.
*Index:integerThe index number of list
*Value:stringThe value to be placed at the index of the list.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Insert all the specified values at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.

Runtime Class - com.ibi.agents.XDRedisListsLPush



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the list is stored at.
*Value:stringThe value to be stored in the list.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Inserts all the specified values at the tail of the list stored at key. If the key does not exist, it is created as empty list before performing the push operation. When key holds a value that is not a list, an error is returned.

Runtime Class - com.ibi.agents.XDRedisListsRPush



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the list is stored at.
*Value:stringThe value to be stored in the list.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Removes and returns the first element of the list stored at key.

Runtime Class - com.ibi.agents.XDRedisListsLPop



Parameter Groups

 ParameterTypeDescription
*Name:stringThe name of the key the list is stored at.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Removes and returns the last element of the list stored at key.

Runtime Class - com.ibi.agents.XDRedisListsRPop



Parameter Groups

 ParameterTypeDescription
*Name:stringThe name of the key the list is stored at.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Set a timeout on the specified key. After the timeout the key will be automatically deleted by the server. A key with an associated timeout is said to be volatile in Redis terminology.

Runtime Class - com.ibi.agents.XDRedisKeyExpire



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key to set a timeout.
*Seconds:integerThe number of seconds the selected key is set to expire.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.
Description - Remove the existing timeout on key, turning the key from volatile (a key with an expire set) to persistent (a key that will never expire as no timeout is associated).

Runtime Class - com.ibi.agents.XDRedisKeyPersist



Parameter Groups

 ParameterTypeDescription
*Name:stringThe name of the key to be persist.
* - denotes required
 ParameterTypeDescription
Return:stringDocument to return from the object.

Select from one of the following options:
  • Status Document {status} - Status document will be the out document.
  • Input Document {input} - Input document will be the out document.
* - denotes required

Output Events

NameDescription
onFailConnectCould not connect to the external system.
fail_parseCould not parse a document.
fail_redisA fail Redis API
onFailOperationCould not perform the operation requested.