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

Class WatchQueryIndexesOptions

java.lang.Object

com.couchbase.client.java.CommonOptions<WatchQueryIndexesOptions>

com.couchbase.client.java.manager.query.WatchQueryIndexesOptions

public class WatchQueryIndexesOptions
extends CommonOptions<WatchQueryIndexesOptions>

Allows customizing how the query indexes are watched.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WatchQueryIndexesOptions.Built

Nested classes/interfaces inherited from class com.couchbase.client.java.CommonOptions

CommonOptions.BuiltCommonOptions

Method Summary

Modifier and Type	Method	Description
WatchQueryIndexesOptions.Built	build()
WatchQueryIndexesOptions	collectionName(String collectionName)	Deprecated.
WatchQueryIndexesOptions	scopeName(String scopeName)	Deprecated. `collection.queryIndexes()` should now be used for collection-related query index operations.
WatchQueryIndexesOptions	watchPrimary(boolean watchPrimary)	Deprecated. `collection.queryIndexes()` should now be used for collection-related query index operations.
static WatchQueryIndexesOptions	watchQueryIndexesOptions()	Creates a new instance with default values.

Methods inherited from class com.couchbase.client.java.CommonOptions

clientContext, parentSpan, retryStrategy, self, timeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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)

Deprecated.

`collection.queryIndexes()` should now be used for collection-related query index operations.

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

@Deprecated
public WatchQueryIndexesOptions scopeName(String scopeName)

Deprecated.

`collection.queryIndexes()` should now be used for collection-related query index operations.

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

@Deprecated
public WatchQueryIndexesOptions collectionName(String collectionName)

Deprecated.

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()