GetAllQueryIndexesOptions (Couchbase Java SDK 3.2.7 API)

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 Description

class GetAllQueryIndexesOptions.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
`GetAllQueryIndexesOptions.Built`	`build()`
`GetAllQueryIndexesOptions`	`collectionName(String collectionName)`	Sets the collection name for this query management operation.
`static GetAllQueryIndexesOptions`	`getAllQueryIndexesOptions()`	Creates a new instance with default values.
`GetAllQueryIndexesOptions`	`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
  - getAllQueryIndexesOptions
```
public static GetAllQueryIndexesOptions getAllQueryIndexesOptions()
```
    Creates a new instance with default values.
    
    Returns:
    
    the instantiated default options.
  - scopeName
```
@Uncommitted
public GetAllQueryIndexesOptions scopeName(String scopeName)
```
    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
```
@Uncommitted
public GetAllQueryIndexesOptions 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 GetAllQueryIndexesOptions.Built build()
```