ScanDirectives.Builder (Apache Accumulo Core 2.1.0-SNAPSHOT API)

Enclosing interface:: ScanDirectives

public static interface ScanDirectives.Builder

Since:: 2.1.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ScanDirectives`	`build()`
`ScanDirectives.Builder`	`setDataCacheUsage(ScanDirectives.CacheUsage usage)`	If this is not called, then `ScanDirectives.CacheUsage.TABLE` should be used.
`ScanDirectives.Builder`	`setExecutorName(String name)`	If this is not called, then "default" should be used.
`ScanDirectives.Builder`	`setIndexCacheUsage(ScanDirectives.CacheUsage usage)`	If this is not called, then `ScanDirectives.CacheUsage.TABLE` should be used.

- Method Detail
  - setExecutorName
```
ScanDirectives.Builder setExecutorName(String name)
```
    If this is not called, then "default" should be used.
    
    Parameters:
    
    name - a non null name of an existing scan executor to use for this scan from the key set of ScanDispatcher.DispatchParameters.getScanExecutors()
    
    Returns:
    
    may return self or a new object
  - setIndexCacheUsage
```
ScanDirectives.Builder setIndexCacheUsage(ScanDirectives.CacheUsage usage)
```
    If this is not called, then ScanDirectives.CacheUsage.TABLE should be used.
    
    Parameters:
    
    usage - a non null usage indicating how the scan should use cache for file metadata (like the index tree within a file)
    
    Returns:
    
    may return self or a new object
  - setDataCacheUsage
```
ScanDirectives.Builder setDataCacheUsage(ScanDirectives.CacheUsage usage)
```
    If this is not called, then ScanDirectives.CacheUsage.TABLE should be used.
    
    Parameters:
    
    usage - a non null usage indicating how the scan should use cache for file data
    
    Returns:
    
    may return self or a new object
  - build
```
ScanDirectives build()
```
    Returns:
    
    an immutable ScanDirectives object.