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 Details

    • 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 Details

    • values

      public static SearchScanConsistency[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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