io.valkey.resps

Class CommandInfo

java.lang.Object

io.valkey.resps.CommandInfo

public class CommandInfo
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Builder<CommandInfo>	COMMAND_INFO_BUILDER

Constructor Summary

Constructors

Constructor and Description
CommandInfo(long arity, List<String> flags, long firstKey, long lastKey, long step, List<String> aclCategories, List<String> tips, List<String> subcommands)

Method Summary

Modifier and Type	Method and Description
List<String>	getAclCategories() An array of simple strings that are the ACL categories to which the command belongs
long	getArity() Arity is the number of arguments a command expects.
long	getFirstKey() The position of the command's first key name argument
List<String>	getFlags() Command flags
long	getLastKey() The position of the command's last key name argument Commands that accept a single key have both first key and last key set to 1
long	getStep() This value is the step, or increment, between the first key and last key values where the keys are
List<String>	getSubcommands() All the command's subcommands, if any
List<String>	getTips() Helpful information about the command

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_INFO_BUILDER

public static final Builder<CommandInfo> COMMAND_INFO_BUILDER

Constructor Detail

CommandInfo

public CommandInfo(long arity,
                   List<String> flags,
                   long firstKey,
                   long lastKey,
                   long step,
                   List<String> aclCategories,
                   List<String> tips,
                   List<String> subcommands)

Method Detail

getArity

public long getArity()

Arity is the number of arguments a command expects. It follows a simple pattern: A positive integer means a fixed number of arguments. A negative integer means a minimal number of arguments. Examples: GET's arity is 2 since the command only accepts one argument and always has the format GET _key_. MGET's arity is -2 since the command accepts at least one argument, but possibly multiple ones: MGET _key1_ [key2] [key3] ....

getFlags

public List<String> getFlags()

Command flags

getFirstKey

public long getFirstKey()

The position of the command's first key name argument

getLastKey

public long getLastKey()

The position of the command's last key name argument Commands that accept a single key have both first key and last key set to 1

getStep

public long getStep()

This value is the step, or increment, between the first key and last key values where the keys are

getAclCategories

public List<String> getAclCategories()

An array of simple strings that are the ACL categories to which the command belongs

getTips

public List<String> getTips()

Helpful information about the command

getSubcommands

public List<String> getSubcommands()

All the command's subcommands, if any