CompactionPlanner.PlanningParameters (Apache Accumulo Core 2.1.1 API)

Enclosing interface:

CompactionPlanner
```
public static interface CompactionPlanner.PlanningParameters
```
This interface exists so the API can evolve and additional parameters can be passed to the method in the future.

Since:

2.1.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CompactionPlan.Builder`	`createPlanBuilder()`
`Collection<CompactableFile>`	`getAll()`
`Collection<CompactableFile>`	`getCandidates()`
`Map<String,String>`	`getExecutionHints()`
`CompactionKind`	`getKind()`
`double`	`getRatio()`
`Collection<CompactionJob>`	`getRunningCompactions()`
`ServiceEnvironment`	`getServiceEnvironment()`
`TableId`	`getTableId()`

- Method Detail
  - getTableId
```
TableId getTableId()
```
    Returns:
    
    The id of the table that compactions are being planned for.
    
    See Also:
    
    PluginEnvironment.getTableName(TableId)
  - getServiceEnvironment
```
ServiceEnvironment getServiceEnvironment()
```
  - getKind
```
CompactionKind getKind()
```
  - getRatio
```
double getRatio()
```
    Returns:
    
    the compaction ratio configured for the table
  - getAll
```
Collection<CompactableFile> getAll()
```
    Returns:
    
    the set of all files a tablet has.
  - getCandidates
```
Collection<CompactableFile> getCandidates()
```
    Returns:
    
    the set of files that could be compacted depending on what getKind() returns.
  - getRunningCompactions
```
Collection<CompactionJob> getRunningCompactions()
```
    Returns:
    
    jobs that are currently running
  - getExecutionHints
```
Map<String,String> getExecutionHints()
```
    Returns:
    
    For a user compaction (when getKind() returns CompactionKind.USER) where the user set execution hints via CompactionConfig.setExecutionHints(Map) this will return those hints. Otherwise this will return an immutable empty map.
  - createPlanBuilder
```
CompactionPlan.Builder createPlanBuilder()
```
    Returns:
    
    A compaction plan builder that must be used to create a compaction plan.