io.redisearch.client

Enum AddOptions.ReplacementPolicy

java.lang.Object

java.lang.Enum<AddOptions.ReplacementPolicy>

io.redisearch.client.AddOptions.ReplacementPolicy

All Implemented Interfaces:

Serializable, Comparable<AddOptions.ReplacementPolicy>

Enclosing class:

AddOptions

public static enum AddOptions.ReplacementPolicy
extends Enum<AddOptions.ReplacementPolicy>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL Replace/reindex the entire document.
NONE The default mode.
PARTIAL Only reindex/replace fields that are updated in the command.

Method Summary

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

NONE

public static final AddOptions.ReplacementPolicy NONE

The default mode. This will cause the add operation to fail if the document already exists

FULL

public static final AddOptions.ReplacementPolicy FULL

Replace/reindex the entire document. This has the effect of atomically deleting the previous document and replacing it with the context of the new document. Fields in the old document which are not present in the new document are lost

PARTIAL

public static final AddOptions.ReplacementPolicy PARTIAL

Only reindex/replace fields that are updated in the command. Fields in the old document which are not present in the new document are preserved. Fields that are present in both are overwritten by the new document

Method Detail

values

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

Returns:

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

valueOf

public static AddOptions.ReplacementPolicy 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