Class DropPrimaryQueryIndexOptions
- java.lang.Object
-
- com.couchbase.client.java.CommonOptions<DropPrimaryQueryIndexOptions>
-
- com.couchbase.client.java.manager.query.DropPrimaryQueryIndexOptions
-
public class DropPrimaryQueryIndexOptions extends CommonOptions<DropPrimaryQueryIndexOptions>
Allows customizing how primary indexes are dropped.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classDropPrimaryQueryIndexOptions.Built-
Nested classes/interfaces inherited from class com.couchbase.client.java.CommonOptions
CommonOptions.BuiltCommonOptions
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DropPrimaryQueryIndexOptions.Builtbuild()DropPrimaryQueryIndexOptionscollectionName(String collectionName)Sets the collection name for this query management operation.static DropPrimaryQueryIndexOptionsdropPrimaryQueryIndexOptions()Creates a new instance with default values.DropPrimaryQueryIndexOptionsignoreIfNotExists(boolean ignore)If the index does not exist, an exception will be thrown unless this is set to true.DropPrimaryQueryIndexOptionsscopeName(String scopeName)Sets the scope name for this query management operation.-
Methods inherited from class com.couchbase.client.java.CommonOptions
clientContext, parentSpan, retryStrategy, self, timeout
-
-
-
-
Method Detail
-
dropPrimaryQueryIndexOptions
public static DropPrimaryQueryIndexOptions dropPrimaryQueryIndexOptions()
Creates a new instance with default values.- Returns:
- the instantiated default options.
-
ignoreIfNotExists
public DropPrimaryQueryIndexOptions ignoreIfNotExists(boolean ignore)
If the index does not exist, an exception will be thrown unless this is set to true.
-
scopeName
public DropPrimaryQueryIndexOptions 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 DropPrimaryQueryIndexOptions 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 DropPrimaryQueryIndexOptions.Built build()
-
-