java.lang.Object
- com.arangodb.entity.arangosearch.ConsolidationPolicy

public final class ConsolidationPolicy
extends Object

Author:: Mark Vollmary

Constructor Summary

Constructors
Constructor Description

ConsolidationPolicy()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`Long`	`getMinScore()`
`Long`	`getSegmentsBytesFloor()`
`Long`	`getSegmentsBytesMax()`
`Long`	`getSegmentsMax()`
`Long`	`getSegmentsMin()`
`Double`	`getThreshold()`
`ConsolidationType`	`getType()`
`int`	`hashCode()`
`ConsolidationPolicy`	`minScore(Long minScore)`
`static ConsolidationPolicy`	`of(ConsolidationType type)`
`ConsolidationPolicy`	`segmentsBytesFloor(Long segmentsBytesFloor)`
`ConsolidationPolicy`	`segmentsBytesMax(Long segmentsBytesMax)`
`ConsolidationPolicy`	`segmentsMax(Long segmentsMax)`
`ConsolidationPolicy`	`segmentsMin(Long segmentsMin)`
`ConsolidationPolicy`	`threshold(Double threshold)`
`ConsolidationPolicy`	`type(ConsolidationType type)`

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

- Constructor Detail
  - ConsolidationPolicy
```
public ConsolidationPolicy()
```
- Method Detail
  - of
```
public static ConsolidationPolicy of(ConsolidationType type)
```
  - type
```
public ConsolidationPolicy type(ConsolidationType type)
```
  - threshold
```
public ConsolidationPolicy threshold(Double threshold)
```
    Parameters:
    
    threshold - value in the range [0.0, 1.0]
    
    Returns:
    
    this
  - getType
```
public ConsolidationType getType()
```
  - getThreshold
```
public Double getThreshold()
```
  - getSegmentsMin
```
public Long getSegmentsMin()
```
  - segmentsMin
```
public ConsolidationPolicy segmentsMin(Long segmentsMin)
```
    Parameters:
    
    segmentsMin - The minimum number of segments that will be evaluated as candidates for consolidation. (default: 1)
    
    Returns:
    
    this
  - getSegmentsMax
```
public Long getSegmentsMax()
```
  - segmentsMax
```
public ConsolidationPolicy segmentsMax(Long segmentsMax)
```
    Parameters:
    
    segmentsMax - The maximum number of segments that will be evaluated as candidates for consolidation. (default: 10)
    
    Returns:
    
    this
  - getSegmentsBytesMax
```
public Long getSegmentsBytesMax()
```
  - segmentsBytesMax
```
public ConsolidationPolicy segmentsBytesMax(Long segmentsBytesMax)
```
    Parameters:
    
    segmentsBytesMax - Maximum allowed size of all consolidated segments in bytes. (default: 5368709120)
    
    Returns:
    
    this
  - getSegmentsBytesFloor
```
public Long getSegmentsBytesFloor()
```
  - segmentsBytesFloor
```
public ConsolidationPolicy segmentsBytesFloor(Long segmentsBytesFloor)
```
    Parameters:
    
    segmentsBytesFloor - Defines the value (in bytes) to treat all smaller segments as equal for consolidation selection. (default: 2097152)
    
    Returns:
    
    this
  - getMinScore
```
public Long getMinScore()
```
  - minScore
```
public ConsolidationPolicy minScore(Long minScore)
```
    Parameters:
    
    minScore - Filter out consolidation candidates with a score less than this. (default: 0)
    
    Returns:
    
    this
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ConsolidationPolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsolidationPolicy

Method Detail

of

type

threshold

getType

getThreshold

getSegmentsMin

segmentsMin

getSegmentsMax

segmentsMax

getSegmentsBytesMax

segmentsBytesMax

getSegmentsBytesFloor

segmentsBytesFloor

getMinScore

minScore

equals

hashCode