redis connector

Description - Returns the remaining time to live of a key that has a timeout. This introspection capability allows a Redis client to check how many seconds a given key will continue to be part of the dataset.

Runtime Class - com.ibi.agents.XDRedisKeyTTL



Parameter Groups

 ParameterTypeDescription
*Name:stringA key will be checked that how many seconds continue to be part of the dataset.
* - 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 - Tests if the specified key exists in the selected database.

Runtime Class - com.ibi.agents.XDRedisKeyExists



Parameter Groups

 ParameterTypeDescription
*Key:stringName of the key to check for its existence.
* - 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 - ExpireAt works exactly like Expire but instead to get the number of seconds representing the Time To Live of the key as a second argument (that is a relative way of specifing the TTL), it takes an absolute one in the form of a UNIX timestamp (Number of seconds elapsed since 1 Gen 1970).

Runtime Class - com.ibi.agents.XDRedisKeyExpireAt



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key to set a timeout.
*Unix Time:stringA UNIX timestamp (Number of seconds elapsed since 1 Gen 1970) which the specified 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 - If key holds a hash, retrieve the value associated to the specified field. If the field is not found or the key does not exist, a special 'nil' value is returned.

Runtime Class - com.ibi.agents.XDRedisHashesGet



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the hash is stored at.
*Field:stringThe name of the field within the hash to look up its value.
* - 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 the specified fields from the hash stored at key

Runtime Class - com.ibi.agents.XDRedisHashesDel



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the hash is stored at.
*Field:stringThe field to delete in the hash.
* - 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 the specified fields from the hash stored at key

Runtime Class - com.ibi.agents.XDRedisHashesDel



Parameter Groups

 ParameterTypeDescription
*Key:stringThe name of the key the hash is stored at.
*Field:stringThe field to delete in the hash.
* - 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 - Returns the substring of the string value stored at key, determined by the offsets start and end (both are inclusive). Negative offsets can be used in order to provide an offset starting from the end of the string. So -1 means the last character, -2 the penultimate and so forth.

Runtime Class - com.ibi.agents.XDRedisStringGetRange



Parameter Groups

 ParameterTypeDescription
*Key:stringThe key associated with the string.
*Start:stringStart offset:
*End:stringEnd offset:
* - 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 - Get the value of key. If the key does not exist the special value nil is returned. An error is returned if the value stored at key is not a string, because GET only handles string values.

Runtime Class - com.ibi.agents.XDRedisStringGet



Parameter Groups

 ParameterTypeDescription
*Name:stringThe key associated with the string.
* - 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 - Delete all the keys of the currently selected DB. This command never fails.

Runtime Class - com.ibi.agents.XDRedisServerFlushDB



Parameter Groups

 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 - Delete all the keys of all the existing databases, not just the currently selected one. This command never fails.

Runtime Class - com.ibi.agents.XDRedisServerFlushAll



Parameter Groups

 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.