com.couchbase.client.java.analytics

Enum AnalyticsScanConsistency

java.lang.Object

java.lang.Enum<AnalyticsScanConsistency>

com.couchbase.client.java.analytics.AnalyticsScanConsistency

All Implemented Interfaces:

Serializable, Comparable<AnalyticsScanConsistency>

public enum AnalyticsScanConsistency
extends Enum<AnalyticsScanConsistency>

The possible values for scan consistency in an analytics request.

Since:

3.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOT_BOUNDED The index will return whatever state it has to the analytics query engine at the time of query.
REQUEST_PLUS The index will wait until all mutations have been processed at the time of request before being processed in the analytics query engine.

Method Summary

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

The index will return whatever state it has to the analytics query engine at the time of query.

This is the default (for single-statement requests). No timestamp vector is used in the index scan. 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.

REQUEST_PLUS

public static final AnalyticsScanConsistency REQUEST_PLUS

The index will wait until all mutations have been processed at the time of request before being processed in the analytics query engine.

This implements strong consistency per request. Before processing the request, a current vector is obtained. The vector is used as a lower bound for the statements in the request.

Method Detail

values

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

Returns:

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

valueOf

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