redis.clients.jedis

Enum CommandFlagsRegistry.RequestPolicy

java.lang.Object

java.lang.Enum<CommandFlagsRegistry.RequestPolicy>

redis.clients.jedis.CommandFlagsRegistry.RequestPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommandFlagsRegistry.RequestPolicy>

Enclosing interface:

CommandFlagsRegistry

public static enum CommandFlagsRegistry.RequestPolicy
extends java.lang.Enum<CommandFlagsRegistry.RequestPolicy>

Request policy for commands in a clustered deployment. This tip helps clients determine which shards to send the command to in clustering mode. See Request policy for more details.

Policy values:

• DEFAULT: No specific request policy defined. For commands without key arguments, execute on an arbitrary shard. For commands with key arguments, route to a single shard based on the hash slot of input keys.
• ALL_NODES: Execute the command on all nodes - masters and replicas alike. Example: CONFIG SET. Used by commands that don't accept key name arguments and operate atomically per shard.
• ALL_SHARDS: Execute the command on all master shards. Example: DBSIZE. Used by commands that don't accept key name arguments and operate atomically per shard.
• MULTI_SHARD: Execute the command on several shards. The client should split the inputs according to the hash slots of input key name arguments. Example: DEL, MSET, MGET.
• SPECIAL: Indicates a non-trivial form of request policy. Example: SCAN.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_NODES
ALL_SHARDS
DEFAULT
MULTI_SHARD
SPECIAL

Method Summary

Modifier and Type	Method and Description
static CommandFlagsRegistry.RequestPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommandFlagsRegistry.RequestPolicy[]	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

DEFAULT

public static final CommandFlagsRegistry.RequestPolicy DEFAULT

ALL_NODES

public static final CommandFlagsRegistry.RequestPolicy ALL_NODES

ALL_SHARDS

public static final CommandFlagsRegistry.RequestPolicy ALL_SHARDS

MULTI_SHARD

public static final CommandFlagsRegistry.RequestPolicy MULTI_SHARD

SPECIAL

public static final CommandFlagsRegistry.RequestPolicy SPECIAL

Method Detail

values

public static CommandFlagsRegistry.RequestPolicy[] 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 (CommandFlagsRegistry.RequestPolicy c : CommandFlagsRegistry.RequestPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommandFlagsRegistry.RequestPolicy valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null