com.aerospike.client.policy

Enum Replica

java.lang.Object

java.lang.Enum<Replica>

com.aerospike.client.policy.Replica

All Implemented Interfaces:

Serializable, Comparable<Replica>

public enum Replica
extends Enum<Replica>

Defines algorithm used to determine the target node for a command. The replica algorithm only affects single record commands. Batch, scan and query are not affected by replica algorithm.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MASTER Use node containing key's master partition.
MASTER_PROLES Distribute reads across nodes containing key's master and replicated partitions in round-robin fashion.
RANDOM Distribute reads across all nodes in cluster in round-robin fashion.
SEQUENCE Try node containing master partition first.

Method Summary

Modifier and Type	Method and Description
static Replica	valueOf(String name) Returns the enum constant of this type with the specified name.
static Replica[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MASTER

public static final Replica MASTER

Use node containing key's master partition.

MASTER_PROLES

public static final Replica MASTER_PROLES

Distribute reads across nodes containing key's master and replicated partitions in round-robin fashion. Writes always use node containing key's master partition.

This option requires ClientPolicy.requestProleReplicas to be enabled in order to function properly.

SEQUENCE

public static final Replica SEQUENCE

Try node containing master partition first. If connection fails, all commands try nodes containing replicated partitions. If socketTimeout is reached, reads also try nodes containing replicated partitions, but writes remain on master node.

This option requires ClientPolicy.requestProleReplicas to be enabled in order to function properly.

RANDOM

public static final Replica RANDOM

Distribute reads across all nodes in cluster in round-robin fashion. Writes always use node containing key's master partition.

This option is useful when the replication factor equals the number of nodes in the cluster and the overhead of requesting proles is not desired.

Method Detail

values

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

Returns:

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

valueOf

public static Replica 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