org.apache.flink.streaming.connectors.redis.common.mapper

Class RedisCommandDescription

java.lang.Object

org.apache.flink.streaming.connectors.redis.common.mapper.RedisCommandDescription

All Implemented Interfaces:

Serializable

public class RedisCommandDescription
extends Object
implements Serializable

The description of the command type. This must be passed while creating new RedisMapper.

When creating descriptor for the group of RedisDataType.HASH and RedisDataType.SORTED_SET, you need to use first constructor RedisCommandDescription(RedisCommand, String). If the additionalKey is null it will throw IllegalArgumentException

When RedisCommand is not in group of RedisDataType.HASH and RedisDataType.SORTED_SET you can use second constructor RedisCommandDescription(RedisCommand)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RedisCommandDescription(RedisCommand redisCommand) Use this constructor when command type is not in group RedisDataType.HASH or RedisDataType.SORTED_SET.
RedisCommandDescription(RedisCommand redisCommand, String additionalKey) Use this constructor when data type is RedisDataType.HASH or RedisDataType.SORTED_SET.

Method Summary

Modifier and Type	Method and Description
String	getAdditionalKey() Returns the additional key if data type is RedisDataType.HASH and RedisDataType.SORTED_SET.
RedisCommand	getCommand() Returns the RedisCommand.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedisCommandDescription

public RedisCommandDescription(RedisCommand redisCommand,
                               String additionalKey)

Use this constructor when data type is RedisDataType.HASH or RedisDataType.SORTED_SET. If different data type is specified, additionalKey is ignored.

Parameters:

redisCommand - the redis command type RedisCommand

additionalKey - additional key for Hash and Sorted set data type

RedisCommandDescription

public RedisCommandDescription(RedisCommand redisCommand)

Use this constructor when command type is not in group RedisDataType.HASH or RedisDataType.SORTED_SET.

Parameters:

redisCommand - the redis data type RedisCommand

Method Detail

getCommand

public RedisCommand getCommand()

Returns the RedisCommand.

Returns:

the command type of the mapping

getAdditionalKey

public String getAdditionalKey()

Returns the additional key if data type is RedisDataType.HASH and RedisDataType.SORTED_SET.

Returns:

the additional key