com.couchbase.client.java.search

Enum SearchScanConsistency

java.lang.Object

java.lang.Enum<SearchScanConsistency>

com.couchbase.client.java.search.SearchScanConsistency

All Implemented Interfaces:

Serializable, Comparable<SearchScanConsistency>

public enum SearchScanConsistency
extends Enum<SearchScanConsistency>

An enum listing the various consistency levels for FTS searches that don't need additional parameters (like a mutation token vector).

Since:

2.3

Author:

Simon Baslé

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOT_BOUNDED This is the default, the indexer does not wait for certain index updates until it returns the current hits.

Method Summary

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

NOT_BOUNDED

public static final SearchScanConsistency NOT_BOUNDED

This is the default, the indexer does not wait for certain index updates until it returns the current hits.

This is also the fastest mode, because we avoid the cost of obtaining the vector, and we also avoid any wait for the index to catch up to the vector.

Method Detail

values

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

Returns:

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

valueOf

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