com.couchbase.client.java.manager.query

Class GetAllQueryIndexesOptions

java.lang.Object

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

com.couchbase.client.java.manager.query.GetAllQueryIndexesOptions

public class GetAllQueryIndexesOptions
extends CommonOptions<GetAllQueryIndexesOptions>

Allows customizing how query indexes are loaded.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GetAllQueryIndexesOptions.Built

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

CommonOptions.BuiltCommonOptions

Method Summary

Modifier and Type	Method and Description
GetAllQueryIndexesOptions.Built	build()
GetAllQueryIndexesOptions	collectionName(String collectionName) Deprecated. `collection.queryIndexes()` should now be used for collection-related query index operations.
static GetAllQueryIndexesOptions	getAllQueryIndexesOptions() Creates a new instance with default values.
GetAllQueryIndexesOptions	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 Detail

getAllQueryIndexesOptions

public static GetAllQueryIndexesOptions getAllQueryIndexesOptions()

Creates a new instance with default values.

Returns:

the instantiated default options.

scopeName

@Deprecated
public GetAllQueryIndexesOptions 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.

If the scope name is set but the collectionName(String) (String)} is not, then all indexes within a scope (for all the collections inside) will be returned.

Parameters:

scopeName - the name of the scope.

Returns:

this options class for chaining purposes.

collectionName

@Deprecated
public GetAllQueryIndexesOptions 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

@Stability.Internal
public GetAllQueryIndexesOptions.Built build()