RedisCommand (AREDIS API)

java.lang.Object
- java.lang.Enum<RedisCommand>
- - org.aredis.cache.RedisCommand

All Implemented Interfaces:

Serializable, Comparable<RedisCommand>
```
public enum RedisCommand
extends Enum<RedisCommand>
```
Enumerates the Redis Commands and also contains information about the command argument types using which the AsyncRedisConnection determines the arguments to which to used the Data Handler.

Author:

Suresh

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPEND`
`AUTH` The AUTH command is used internally to send authentication to the Redis Server on connecting.
`BGREWRITEAOF`
`BGSAVE`
`BITCOUNT`
`BITOP`
`BITPOS`
`BLPOP`
`BRPOP`
`BRPOPLPUSH`
`CLIENT`
`CONFIG`
`DBSIZE`
`DECR`
`DECRBY`
`DEL`
`DISCARD`
`DUMP`
`ECHO`
`EVAL`
`EVALCHECK` EVALCHECK is a pseudo command that ensures that a Redis script is loaded before sending an EVALSHA command for the first time, using SCRIPT EXISTS and SCRIPT LOAD commands.
`EVALSHA`
`EXEC`
`EXISTS`
`EXPIRE`
`EXPIREAT`
`FLUSHALL`
`FLUSHDB`
`GET`
`GETBIT`
`GETRANGE`
`GETSET`
`HDEL`
`HEXISTS`
`HGET`
`HGETALL`
`HINCRBY`
`HINCRBYFLOAT`
`HKEYS`
`HLEN`
`HMGET`
`HMSET`
`HSCAN`
`HSET`
`HSETNX`
`HVALS`
`INCR`
`INCRBY`
`INCRBYFLOAT`
`INFO`
`KEYS`
`LASTSAVE`
`LINDEX`
`LINSERT`
`LLEN`
`LPOP`
`LPUSH`
`LPUSHX`
`LRANGE`
`LREM`
`LSET`
`LTRIM`
`MGET`
`MIGRATE`
`MOVE`
`MSET`
`MSETNX`
`MULTI`
`OBJECT`
`PERSIST`
`PEXPIRE`
`PEXPIREAT`
`PFADD`
`PFCOUNT`
`PFMERGE`
`PING`
`PSETEX`
`PSUBSCRIBE`
`PTTL`
`PUBLISH`
`PUBSUB`
`PUNSUBSCRIBE`
`RANDOMKEY`
`RENAME`
`RENAMENX`
`RESTORE`
`RPOP`
`RPOPLPUSH`
`RPUSH`
`RPUSHX`
`SADD`
`SAVE`
`SCAN`
`SCARD`
`SCRIPT`
`SDIFF`
`SDIFFSTORE`
`SELECT`
`SET`
`SETBIT`
`SETEX`
`SETNX`
`SETRANGE`
`SHUTDOWN`
`SINTER`
`SINTERSTORE`
`SISMEMBER`
`SLAVEOF`
`SLOWLOG`
`SMEMBERS`
`SMOVE`
`SORT`
`SPOP`
`SRANDMEMBER`
`SREM`
`SSCAN`
`STRLEN`
`SUBSCRIBE`
`SUNION`
`SUNIONSTORE`
`TIME`
`TTL`
`TYPE`
`UNSUBSCRIBE`
`UNWATCH`
`WATCH`
`ZADD`
`ZCARD`
`ZCOUNT`
`ZINCRBY`
`ZINTERSTORE`
`ZLEXCOUNT`
`ZRANGE`
`ZRANGEBYLEX`
`ZRANGEBYSCORE`
`ZRANK`
`ZREM`
`ZREMRANGEBYLEX`
`ZREMRANGEBYRANK`
`ZREMRANGEBYSCORE`
`ZREVRANGE`
`ZREVRANGEBYSCORE`
`ZREVRANK`
`ZSCAN`
`ZSCORE`
`ZUNIONSTORE`

Method Summary

Methods
Modifier and Type	Method and Description
`char[]`	`getArgTypes()` Gets the command argument types as a character array.
`int`	`getRepeatableFromIndex()` Gets the repeatable from index int argTypes from which the argTypes are repeated or -1 if there is a fixed list of arguments.
`boolean`	`isBlocking()` Identifies blocking commands like BLPOP
`boolean`	`isScriptCommand()` Identifies if the command is one of the SCRIPT commands, EVAL, EVALSHA, EVALCHECK or SCRIPT.
`boolean`	`isStateful()` Identifies if the command is stateful i.e the command has an effect on subsequent commands run on the same connections.
`boolean`	`isUseKeyHandlerAsDefaultDataHandler()` Gets if Key Handler is to be used as the default data handler for this command.
`static RedisCommand`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RedisCommand[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

APPEND

public static final RedisCommand APPEND

AUTH
```
public static final RedisCommand AUTH
```
The AUTH command is used internally to send authentication to the Redis Server on connecting. aredis users should use the AsyncRedisFactory.setAuth(String, String) to configure the password.

BGREWRITEAOF

public static final RedisCommand BGREWRITEAOF

BGSAVE

public static final RedisCommand BGSAVE

BITCOUNT

public static final RedisCommand BITCOUNT

BITOP
```
public static final RedisCommand BITOP
```

BITPOS

public static final RedisCommand BITPOS

BLPOP
```
public static final RedisCommand BLPOP
```

BRPOP
```
public static final RedisCommand BRPOP
```

BRPOPLPUSH

public static final RedisCommand BRPOPLPUSH

CLIENT

public static final RedisCommand CLIENT

CONFIG

public static final RedisCommand CONFIG

DBSIZE

public static final RedisCommand DBSIZE

DECR
```
public static final RedisCommand DECR
```

DECRBY

public static final RedisCommand DECRBY

DEL
```
public static final RedisCommand DEL
```

DISCARD

public static final RedisCommand DISCARD

DUMP
```
public static final RedisCommand DUMP
```

ECHO
```
public static final RedisCommand ECHO
```

EVAL
```
public static final RedisCommand EVAL
```

EVALCHECK
```
public static final RedisCommand EVALCHECK
```
EVALCHECK is a pseudo command that ensures that a Redis script is loaded before sending an EVALSHA command for the first time, using SCRIPT EXISTS and SCRIPT LOAD commands. Once loaded the script is flagged as loaded for the server and subsequent EVALCHECK calls to the same script are sent as EVALSHA commands without additional checks. The first parameter should be a Script object. Using this command saves the task of ensuring that a Script is present in the Redis server before calling an EVALSHA since it handles it internally.

EVALSHA

public static final RedisCommand EVALSHA

EXEC
```
public static final RedisCommand EXEC
```

EXISTS

public static final RedisCommand EXISTS

EXPIRE

public static final RedisCommand EXPIRE

EXPIREAT

public static final RedisCommand EXPIREAT

FLUSHALL

public static final RedisCommand FLUSHALL

FLUSHDB

public static final RedisCommand FLUSHDB

GET
```
public static final RedisCommand GET
```

GETBIT

public static final RedisCommand GETBIT

GETRANGE

public static final RedisCommand GETRANGE

GETSET

public static final RedisCommand GETSET

HDEL
```
public static final RedisCommand HDEL
```

HEXISTS

public static final RedisCommand HEXISTS

HGET
```
public static final RedisCommand HGET
```

HGETALL

public static final RedisCommand HGETALL

HINCRBY

public static final RedisCommand HINCRBY

HINCRBYFLOAT

public static final RedisCommand HINCRBYFLOAT

HKEYS
```
public static final RedisCommand HKEYS
```

HLEN
```
public static final RedisCommand HLEN
```

HMGET
```
public static final RedisCommand HMGET
```

HMSET
```
public static final RedisCommand HMSET
```

HSCAN
```
public static final RedisCommand HSCAN
```

HSET
```
public static final RedisCommand HSET
```

HSETNX

public static final RedisCommand HSETNX

HVALS
```
public static final RedisCommand HVALS
```

INCR
```
public static final RedisCommand INCR
```

INCRBY

public static final RedisCommand INCRBY

INCRBYFLOAT

public static final RedisCommand INCRBYFLOAT

INFO
```
public static final RedisCommand INFO
```

KEYS
```
public static final RedisCommand KEYS
```

LASTSAVE

public static final RedisCommand LASTSAVE

LINDEX

public static final RedisCommand LINDEX

LINSERT

public static final RedisCommand LINSERT

LLEN
```
public static final RedisCommand LLEN
```

LPOP
```
public static final RedisCommand LPOP
```

LPUSH
```
public static final RedisCommand LPUSH
```

LPUSHX

public static final RedisCommand LPUSHX

LRANGE

public static final RedisCommand LRANGE

LREM
```
public static final RedisCommand LREM
```

LSET
```
public static final RedisCommand LSET
```

LTRIM
```
public static final RedisCommand LTRIM
```

MGET
```
public static final RedisCommand MGET
```

MIGRATE

public static final RedisCommand MIGRATE

MOVE
```
public static final RedisCommand MOVE
```

MSET
```
public static final RedisCommand MSET
```

MSETNX

public static final RedisCommand MSETNX

MULTI
```
public static final RedisCommand MULTI
```

OBJECT

public static final RedisCommand OBJECT

PERSIST

public static final RedisCommand PERSIST

PEXPIRE

public static final RedisCommand PEXPIRE

PEXPIREAT

public static final RedisCommand PEXPIREAT

PFADD
```
public static final RedisCommand PFADD
```

PFCOUNT

public static final RedisCommand PFCOUNT

PFMERGE

public static final RedisCommand PFMERGE

PING
```
public static final RedisCommand PING
```

PSETEX

public static final RedisCommand PSETEX

PSUBSCRIBE

public static final RedisCommand PSUBSCRIBE

PTTL
```
public static final RedisCommand PTTL
```

PUBLISH

public static final RedisCommand PUBLISH

PUBSUB

public static final RedisCommand PUBSUB

PUNSUBSCRIBE

public static final RedisCommand PUNSUBSCRIBE

RANDOMKEY

public static final RedisCommand RANDOMKEY

RENAME

public static final RedisCommand RENAME

RENAMENX

public static final RedisCommand RENAMENX

RESTORE

public static final RedisCommand RESTORE

RPOP
```
public static final RedisCommand RPOP
```

RPOPLPUSH

public static final RedisCommand RPOPLPUSH

RPUSH
```
public static final RedisCommand RPUSH
```

RPUSHX

public static final RedisCommand RPUSHX

SADD
```
public static final RedisCommand SADD
```

SAVE
```
public static final RedisCommand SAVE
```

SCAN
```
public static final RedisCommand SCAN
```

SCARD
```
public static final RedisCommand SCARD
```

SCRIPT

public static final RedisCommand SCRIPT

SDIFF
```
public static final RedisCommand SDIFF
```

SDIFFSTORE

public static final RedisCommand SDIFFSTORE

SELECT

public static final RedisCommand SELECT

SET
```
public static final RedisCommand SET
```

SETBIT

public static final RedisCommand SETBIT

SETEX
```
public static final RedisCommand SETEX
```

SETNX
```
public static final RedisCommand SETNX
```

SETRANGE

public static final RedisCommand SETRANGE

SHUTDOWN

public static final RedisCommand SHUTDOWN

SINTER

public static final RedisCommand SINTER

SINTERSTORE

public static final RedisCommand SINTERSTORE

SISMEMBER

public static final RedisCommand SISMEMBER

SLAVEOF

public static final RedisCommand SLAVEOF

SLOWLOG

public static final RedisCommand SLOWLOG

SMEMBERS

public static final RedisCommand SMEMBERS

SMOVE
```
public static final RedisCommand SMOVE
```

SORT
```
public static final RedisCommand SORT
```

SPOP
```
public static final RedisCommand SPOP
```

SRANDMEMBER

public static final RedisCommand SRANDMEMBER

SREM
```
public static final RedisCommand SREM
```

SSCAN
```
public static final RedisCommand SSCAN
```

STRLEN

public static final RedisCommand STRLEN

public static final RedisCommand SUBSCRIBE

SUNION

public static final RedisCommand SUNION

SUNIONSTORE

public static final RedisCommand SUNIONSTORE

TIME
```
public static final RedisCommand TIME
```

TTL
```
public static final RedisCommand TTL
```

TYPE
```
public static final RedisCommand TYPE
```

UNSUBSCRIBE

public static final RedisCommand UNSUBSCRIBE

UNWATCH

public static final RedisCommand UNWATCH

WATCH
```
public static final RedisCommand WATCH
```

ZADD
```
public static final RedisCommand ZADD
```

ZCARD
```
public static final RedisCommand ZCARD
```

ZCOUNT

public static final RedisCommand ZCOUNT

ZINCRBY

public static final RedisCommand ZINCRBY

ZINTERSTORE

public static final RedisCommand ZINTERSTORE

ZLEXCOUNT

public static final RedisCommand ZLEXCOUNT

ZRANGE

public static final RedisCommand ZRANGE

ZRANGEBYLEX

public static final RedisCommand ZRANGEBYLEX

ZRANGEBYSCORE

public static final RedisCommand ZRANGEBYSCORE

ZRANK
```
public static final RedisCommand ZRANK
```

ZREM
```
public static final RedisCommand ZREM
```

ZREMRANGEBYLEX

public static final RedisCommand ZREMRANGEBYLEX

ZREMRANGEBYRANK

public static final RedisCommand ZREMRANGEBYRANK

ZREMRANGEBYSCORE

public static final RedisCommand ZREMRANGEBYSCORE

ZREVRANGE

public static final RedisCommand ZREVRANGE

ZREVRANGEBYSCORE

public static final RedisCommand ZREVRANGEBYSCORE

ZREVRANK

public static final RedisCommand ZREVRANK

ZSCAN
```
public static final RedisCommand ZSCAN
```

ZSCORE

public static final RedisCommand ZSCORE

ZUNIONSTORE

public static final RedisCommand ZUNIONSTORE

Method Detail
- values
```
public static RedisCommand[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (RedisCommand c : RedisCommand.values())
    System.out.println(c);
```
  Returns:
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static RedisCommand valueOf(String name)
```
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  name - the name of the enum constant to be returned.
  
  Returns:
  the enum constant with the specified name
  
  Throws:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null
- getArgTypes
```
public char[] getArgTypes()
```
  Gets the command argument types as a character array. In the array k stands for a key, v stands for a value, p stands for a parameter like the expiry in SETEX command or the increment number in INCRBY command, c stands for a count for which the next argType occurs for example in EVAL or ZINTERSTORE. In case the same pattern repeats like in the command MSET it is captured by getRepeatable from index. These two capture the syntax for most redis commands except for ones like BLPOP where we have a parameter after multiple keys and EVAL and EVALSHA where all of the values after the keys are assumed to be values but some of them could be parameters like numbers which should be Ok if you use a Data Handler like JavaHandler which serializes Strings the natural way.
  
  Returns:
  The arg types
- getRepeatableFromIndex
```
public int getRepeatableFromIndex()
```
  Gets the repeatable from index int argTypes from which the argTypes are repeated or -1 if there is a fixed list of arguments. For example for HMSET the argTypes are kpvpv and the repeatable from index is 3 to indicate that pv can be repeated.
  
  Returns:
  Repeatable from Index
- isUseKeyHandlerAsDefaultDataHandler
```
public boolean isUseKeyHandlerAsDefaultDataHandler()
```
  Gets if Key Handler is to be used as the default data handler for this command. This is set for commands without any k in argTypes (i.e without any key arguments) and for *SCAN*, SET and SORTED SET commands (Starting with Z). This is mainly intended to force Bulk responses for these commands to be treated as Strings. This is anyways handled in the default data handler of AsyncRedisConnection unless it is changed.
  
  Returns:
  True if Key Handler is to be used as the default handler instead of the configured default handler
- isBlocking
```
public boolean isBlocking()
```
  Identifies blocking commands like BLPOP
  
  Returns:
  True if the command is blocking
- isStateful
```
public boolean isStateful()
```
  Identifies if the command is stateful i.e the command has an effect on subsequent commands run on the same connections. Examples are WATCH, SELECT, SUBSCRIBE.
  
  Returns:
  True if the command is stateful false otherwise
- isScriptCommand
```
public boolean isScriptCommand()
```
  Identifies if the command is one of the SCRIPT commands, EVAL, EVALSHA, EVALCHECK or SCRIPT.
  
  Returns:
  True if the command is a script command, false otherwise

Enum RedisCommand

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

APPEND

AUTH

BGREWRITEAOF

BGSAVE

BITCOUNT

BITOP

BITPOS

BLPOP

BRPOP

BRPOPLPUSH

CLIENT

CONFIG

DBSIZE

DECR

DECRBY

DEL

DISCARD

DUMP

ECHO

EVAL

EVALCHECK

EVALSHA

EXEC

EXISTS

EXPIRE

EXPIREAT

FLUSHALL

FLUSHDB

GET

GETBIT

GETRANGE

GETSET

HDEL

HEXISTS

HGET

HGETALL

HINCRBY

HINCRBYFLOAT

HKEYS

HLEN

HMGET

HMSET

HSCAN

HSET

HSETNX

HVALS

INCR

INCRBY

INCRBYFLOAT

INFO

KEYS

LASTSAVE

LINDEX

LINSERT

LLEN

LPOP

LPUSH

LPUSHX

LRANGE

LREM

LSET

LTRIM

MGET

MIGRATE

MOVE

MSET

MSETNX

MULTI

OBJECT

PERSIST

PEXPIRE

PEXPIREAT

PFADD

PFCOUNT