DropQueryIndexOptions (Couchbase Java SDK 3.2.6 API)

java.lang.Object
- com.couchbase.client.java.CommonOptions<DropQueryIndexOptions>
- - com.couchbase.client.java.manager.query.DropQueryIndexOptions

public class DropQueryIndexOptions
extends CommonOptions<DropQueryIndexOptions>

Allows customizing how query indexes are dropped.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class DropQueryIndexOptions.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
`DropQueryIndexOptions.Built`	`build()`
`DropQueryIndexOptions`	`collectionName(String collectionName)`	Sets the collection name for this query management operation.
`static DropQueryIndexOptions`	`dropQueryIndexOptions()`	Creates a new instance with default values.
`DropQueryIndexOptions`	`ignoreIfNotExists(boolean ignore)`	If the index does not exist, an exception will be thrown unless this is set to true.
`DropQueryIndexOptions`	`scopeName(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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - dropQueryIndexOptions
```
public static DropQueryIndexOptions dropQueryIndexOptions()
```
    Creates a new instance with default values.
    
    Returns:
    
    the instantiated default options.
  - ignoreIfNotExists
```
public DropQueryIndexOptions ignoreIfNotExists(boolean ignore)
```
    If the index does not exist, an exception will be thrown unless this is set to true.
  - scopeName
```
@Uncommitted
public DropQueryIndexOptions 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
```
@Uncommitted
public DropQueryIndexOptions 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 DropQueryIndexOptions.Built build()
```