org.elasticsearch.index

Enum VersionType

java.lang.Object

java.lang.Enum<VersionType>

org.elasticsearch.index.VersionType

All Implemented Interfaces:

Serializable, Comparable<VersionType>

public enum VersionType
extends Enum<VersionType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXTERNAL
EXTERNAL_GTE
FORCE Warning: this version type should be used with care.
INTERNAL

Method Summary

Methods

Modifier and Type	Method and Description
static VersionType	fromString(String versionType)
static VersionType	fromString(String versionType, VersionType defaultVersionType)
static VersionType	fromValue(byte value)
byte	getValue()
abstract boolean	isVersionConflictForReads(long currentVersion, long expectedVersion) Checks whether the current version conflicts with the expected version, based on the current version type.
abstract boolean	isVersionConflictForWrites(long currentVersion, long expectedVersion) Checks whether the current version conflicts with the expected version, based on the current version type.
abstract long	updateVersion(long currentVersion, long expectedVersion) Returns the new version for a document, based on its current one and the specified in the request
abstract boolean	validateVersionForReads(long version) validate the version is a valid value for this type when reading.
abstract boolean	validateVersionForWrites(long version) validate the version is a valid value for this type when writing.
static VersionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static VersionType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
VersionType	versionTypeForReplicationAndRecovery() Some version types require different semantics for primary and replicas.

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

INTERNAL

public static final VersionType INTERNAL

EXTERNAL

public static final VersionType EXTERNAL

EXTERNAL_GTE

public static final VersionType EXTERNAL_GTE

FORCE

public static final VersionType FORCE

Warning: this version type should be used with care. Concurrent indexing may result in loss of data on replicas

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public byte getValue()

isVersionConflictForWrites

public abstract boolean isVersionConflictForWrites(long currentVersion,
                                 long expectedVersion)

Checks whether the current version conflicts with the expected version, based on the current version type.

Returns:

true if versions conflict false o.w.

isVersionConflictForReads

public abstract boolean isVersionConflictForReads(long currentVersion,
                                long expectedVersion)

Checks whether the current version conflicts with the expected version, based on the current version type.

Returns:

true if versions conflict false o.w.

updateVersion

public abstract long updateVersion(long currentVersion,
                 long expectedVersion)

Returns the new version for a document, based on its current one and the specified in the request

Returns:

new version

validateVersionForWrites

public abstract boolean validateVersionForWrites(long version)

validate the version is a valid value for this type when writing.

Returns:

true if valid, false o.w

validateVersionForReads

public abstract boolean validateVersionForReads(long version)

validate the version is a valid value for this type when reading.

Returns:

true if valid, false o.w

versionTypeForReplicationAndRecovery

public VersionType versionTypeForReplicationAndRecovery()

Some version types require different semantics for primary and replicas. This version allows the type to override the default behavior.

fromString

public static VersionType fromString(String versionType)

fromString

public static VersionType fromString(String versionType,
                     VersionType defaultVersionType)

fromValue

public static VersionType fromValue(byte value)