Package com.couchbase.client.java.manager.query

Class WatchQueryIndexesOptions

java.lang.Object
com.couchbase.client.java.manager.query.WatchQueryIndexesOptions
public class WatchQueryIndexesOptions extends Object
Allows customizing how the query indexes are watched.

  • Method Details

    • watchQueryIndexesOptions

      public static WatchQueryIndexesOptions watchQueryIndexesOptions()
      Creates a new instance with default values.
      Returns:
      the instantiated default options.

    • watchPrimary

      public WatchQueryIndexesOptions watchPrimary(boolean watchPrimary)
      Set to true if the primary index should be included in the watch result.

      Note that if the bucket has no primary index, the watch operation will fail with a IndexNotFoundException.

      Parameters:
      watchPrimary - if the primary index should be included in the watch.
      Returns:
      this options class for chaining purposes.

    • scopeName

      public WatchQueryIndexesOptions scopeName(String scopeName)
      Sets the scope name for this query management operation.

      Please note that if the scope name is set, the collectionName(String) (String)} must also be set.

      Parameters:
      scopeName - the name of the scope.
      Returns:
      this options class for chaining purposes.

    • collectionName

      public WatchQueryIndexesOptions collectionName(String collectionName)
      Sets the collection name for this query management operation.

      Please note that if the collection name is set, the scopeName(String) must also be set.

      Parameters:
      collectionName - the name of the collection.
      Returns:
      this options class for chaining purposes.

    • build

      @Internal public WatchQueryIndexesOptions.Built build()