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

Class BuildQueryIndexOptions

java.lang.Object

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

com.couchbase.client.java.manager.query.BuildQueryIndexOptions

public class BuildQueryIndexOptions
extends CommonOptions<BuildQueryIndexOptions>

Allows customizing how deferred indexes are built.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BuildQueryIndexOptions.Built

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

CommonOptions.BuiltCommonOptions

Method Summary

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

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

buildDeferredQueryIndexesOptions

public static BuildQueryIndexOptions buildDeferredQueryIndexesOptions()

Creates a new instance with default values.

Returns:

the instantiated default options.

scopeName

@Deprecated
public BuildQueryIndexOptions 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 BuildQueryIndexOptions collectionName(String collectionName)

Deprecated.

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

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 BuildQueryIndexOptions.Built build()