SegmentGCOptions (Oak Segment Tar 1.6.4 API)

java.lang.Object
- org.apache.jackrabbit.oak.segment.compaction.SegmentGCOptions

```
public class SegmentGCOptions
extends Object
```
This class holds configuration options for segment store revision gc.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DISABLE_ESTIMATION_DEFAULT` Default value for `isEstimationDisabled()`
`static int`	`FORCE_TIMEOUT_DEFAULT` Default value for `getForceTimeout()` in seconds.
`static long`	`GC_PROGRESS_LOG_DEFAULT` Default value for the gc progress log
`static int`	`MEMORY_THRESHOLD_DEFAULT` Default value for `getMemoryThreshold()`
`static boolean`	`PAUSE_DEFAULT` Default value for `isPaused()`
`static int`	`RETAINED_GENERATIONS_DEFAULT` Default value for `getRetainedGenerations()`
`static int`	`RETRY_COUNT_DEFAULT` Default value for `getRetryCount()`
`static long`	`SIZE_DELTA_ESTIMATION_DEFAULT` Default value for `getGcSizeDeltaEstimation()`.

Constructor Summary

Constructors
Constructor and Description

SegmentGCOptions()

SegmentGCOptions(boolean paused, int retryCount, int forceTimeout)

Constructors
Constructor and Description
`SegmentGCOptions()`
`SegmentGCOptions(boolean paused, int retryCount, int forceTimeout)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SegmentGCOptions`	`defaultGCOptions()` Default options: `PAUSE_DEFAULT`, `RETRY_COUNT_DEFAULT`, `FORCE_TIMEOUT_DEFAULT`.
`long`	`getBinaryDeduplicationMaxSize()`
`int`	`getForceTimeout()` Get the number of seconds to attempt to force compact concurrent commits on top of already compacted commits after the maximum number of retries has been reached.
`GCNodeWriteMonitor`	`getGCNodeWriteMonitor()`
`long`	`getGcSizeDeltaEstimation()`
`int`	`getMemoryThreshold()` Get the available memory threshold beyond which revision gc will be canceled.
`int`	`getRetainedGenerations()` Number of segment generations to retain.
`int`	`getRetryCount()` Get the number of tries to compact concurrent commits on top of already compacted commits
`boolean`	`isBinaryDeduplication()`
`static boolean`	`isDiskSpaceSufficient(long repositoryDiskSpace, long availableDiskSpace)` Check if the approximate repository size is getting too big compared with the available space on disk.
`boolean`	`isEstimationDisabled()`
`boolean`	`isOffline()`
`boolean`	`isPaused()`
`SegmentGCOptions`	`setBinaryDeduplicationMaxSize(long binMaxSize)` Offline compaction only.
`SegmentGCOptions`	`setEstimationDisabled(boolean disabled)` Disables the estimation phase, thus allowing GC to run every time.
`SegmentGCOptions`	`setForceTimeout(int timeout)` Set the number of seconds to attempt to force compact concurrent commits on top of already compacted commits after the maximum number of retries has been reached.
`SegmentGCOptions`	`setGcSizeDeltaEstimation(long gcSizeDeltaEstimation)`
`SegmentGCOptions`	`setMemoryThreshold(int memoryThreshold)` Set the available memory threshold beyond which revision gc will be canceled.
`SegmentGCOptions`	`setOffline()` Enables the offline compaction mode, allowing for certain optimizations, like reducing the retained generation to 1.
`SegmentGCOptions`	`setPaused(boolean paused)` Set revision gc to paused.
`SegmentGCOptions`	`setRetainedGenerations(int retainedGenerations)` Set the number of segment generations to retain: each compaction run creates a new segment generation.
`SegmentGCOptions`	`setRetryCount(int retryCount)` Set the number of tries to compact concurrent commits on top of already compacted commits
`String`	`toString()`
`SegmentGCOptions`	`withBinaryDeduplication()` Offline compaction only.
`SegmentGCOptions`	`withGCNodeWriteMonitor(long gcProgressLog)` Enables the GcWriteMonitor with the given params.

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

- Field Detail
  - PAUSE_DEFAULT
```
public static final boolean PAUSE_DEFAULT
```
    Default value for isPaused()
    
    See Also:
    
    Constant Field Values
  - DISABLE_ESTIMATION_DEFAULT
```
public static final boolean DISABLE_ESTIMATION_DEFAULT
```
    Default value for isEstimationDisabled()
    
    See Also:
    
    Constant Field Values
  - RETRY_COUNT_DEFAULT
```
public static final int RETRY_COUNT_DEFAULT
```
    Default value for getRetryCount()
    
    See Also:
    
    Constant Field Values
  - FORCE_TIMEOUT_DEFAULT
```
public static final int FORCE_TIMEOUT_DEFAULT
```
    Default value for getForceTimeout() in seconds.
    
    See Also:
    
    Constant Field Values
  - RETAINED_GENERATIONS_DEFAULT
```
public static final int RETAINED_GENERATIONS_DEFAULT
```
    Default value for getRetainedGenerations()
    
    See Also:
    
    Constant Field Values
  - SIZE_DELTA_ESTIMATION_DEFAULT
```
public static final long SIZE_DELTA_ESTIMATION_DEFAULT
```
    Default value for getGcSizeDeltaEstimation().
    
    See Also:
    
    Constant Field Values
  - GC_PROGRESS_LOG_DEFAULT
```
public static final long GC_PROGRESS_LOG_DEFAULT
```
    Default value for the gc progress log
    
    See Also:
    
    Constant Field Values
  - MEMORY_THRESHOLD_DEFAULT
```
public static final int MEMORY_THRESHOLD_DEFAULT
```
    Default value for getMemoryThreshold()
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SegmentGCOptions
```
public SegmentGCOptions(boolean paused,
                        int retryCount,
                        int forceTimeout)
```
  - SegmentGCOptions
```
public SegmentGCOptions()
```
- Method Detail
  - defaultGCOptions
```
public static SegmentGCOptions defaultGCOptions()
```
    Default options: PAUSE_DEFAULT, RETRY_COUNT_DEFAULT, FORCE_TIMEOUT_DEFAULT.
  - isPaused
```
public boolean isPaused()
```
    Returns:
    
    true iff revision gc is paused.
  - setPaused
```
public SegmentGCOptions setPaused(boolean paused)
```
    Set revision gc to paused.
    
    Parameters:
    
    paused -
    
    Returns:
    
    this instance
  - getRetryCount
```
public int getRetryCount()
```
    Get the number of tries to compact concurrent commits on top of already compacted commits
    
    Returns:
    
    retry count
  - setRetryCount
```
public SegmentGCOptions setRetryCount(int retryCount)
```
    Set the number of tries to compact concurrent commits on top of already compacted commits
    
    Parameters:
    
    retryCount -
    
    Returns:
    
    this instance
  - getForceTimeout
```
public int getForceTimeout()
```
    Get the number of seconds to attempt to force compact concurrent commits on top of already compacted commits after the maximum number of retries has been reached. Forced compaction acquires an exclusive write lock on the node store.
    
    Returns:
    
    the number of seconds until forced compaction gives up and the exclusive write lock on the node store is released.
  - setForceTimeout
```
public SegmentGCOptions setForceTimeout(int timeout)
```
    Set the number of seconds to attempt to force compact concurrent commits on top of already compacted commits after the maximum number of retries has been reached. Forced compaction acquires an exclusively write lock on the node store.
    
    Parameters:
    
    timeout - the number of seconds until forced compaction gives up and the exclusive lock on the node store is released.
    
    Returns:
    
    this instance
  - getRetainedGenerations
```
public int getRetainedGenerations()
```
    Number of segment generations to retain.
    
    Returns:
    
    number of gc generations.
    
    See Also:
    
    setRetainedGenerations(int)
  - setRetainedGenerations
```
public SegmentGCOptions setRetainedGenerations(int retainedGenerations)
```
    Set the number of segment generations to retain: each compaction run creates a new segment generation. retainGenerations determines how many of those generations are retained during cleanup.
    
    Parameters:
    
    retainedGenerations - number of generations to retain. Must be >= 2.
    
    Returns:
    
    this instance
    
    Throws:
    
    IllegalArgumentException - if retainGenerations < 2
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isDiskSpaceSufficient
```
public static boolean isDiskSpaceSufficient(long repositoryDiskSpace,
                                            long availableDiskSpace)
```
    Check if the approximate repository size is getting too big compared with the available space on disk.
    
    Parameters:
    
    repositoryDiskSpace - Approximate size of the disk space occupied by the repository.
    
    availableDiskSpace - Currently available disk space.
    
    Returns:
    
    true if the available disk space is considered enough for normal repository operations.
  - isOffline
```
public boolean isOffline()
```
  - setOffline
```
public SegmentGCOptions setOffline()
```
    Enables the offline compaction mode, allowing for certain optimizations, like reducing the retained generation to 1.
    
    Returns:
    
    this instance
  - withBinaryDeduplication
```
public SegmentGCOptions withBinaryDeduplication()
```
    Offline compaction only. Enables content based de-duplication of binaries. Involves a fair amount of I/O when reading/comparing potentially equal blobs. set via the 'oak.segment.compaction.binaryDeduplication' system property
    
    Returns:
    
    this instance.
  - isBinaryDeduplication
```
public boolean isBinaryDeduplication()
```
  - setBinaryDeduplicationMaxSize
```
public SegmentGCOptions setBinaryDeduplicationMaxSize(long binMaxSize)
```
    Offline compaction only. Set the upper bound for the content based de-duplication checks.
    
    Parameters:
    
    binMaxSize -
    
    Returns:
    
    this instance
  - getBinaryDeduplicationMaxSize
```
public long getBinaryDeduplicationMaxSize()
```
  - getGcSizeDeltaEstimation
```
public long getGcSizeDeltaEstimation()
```
  - setGcSizeDeltaEstimation
```
public SegmentGCOptions setGcSizeDeltaEstimation(long gcSizeDeltaEstimation)
```
  - getMemoryThreshold
```
public int getMemoryThreshold()
```
    Get the available memory threshold beyond which revision gc will be canceled. Value represents a percentage so an value between 0 and 100 will be returned.
    
    Returns:
    
    memoryThreshold
  - setMemoryThreshold
```
public SegmentGCOptions setMemoryThreshold(int memoryThreshold)
```
    Set the available memory threshold beyond which revision gc will be canceled. Value represents a percentage so an input between 0 and 100 is expected. Setting this to 0 will disable the check.
    
    Parameters:
    
    memoryThreshold -
    
    Returns:
    
    this instance
  - isEstimationDisabled
```
public boolean isEstimationDisabled()
```
  - setEstimationDisabled
```
public SegmentGCOptions setEstimationDisabled(boolean disabled)
```
    Disables the estimation phase, thus allowing GC to run every time.
    
    Returns:
    
    this instance
  - withGCNodeWriteMonitor
```
public SegmentGCOptions withGCNodeWriteMonitor(long gcProgressLog)
```
    Enables the GcWriteMonitor with the given params.
    
    Parameters:
    
    gcProgressLog - Enables compaction progress logging at each set of compacted nodes, disabled if set to -1
    
    Returns:
    
    this instance
  - getGCNodeWriteMonitor
```
public GCNodeWriteMonitor getGCNodeWriteMonitor()
```

Class SegmentGCOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PAUSE_DEFAULT

DISABLE_ESTIMATION_DEFAULT

RETRY_COUNT_DEFAULT

FORCE_TIMEOUT_DEFAULT

RETAINED_GENERATIONS_DEFAULT

SIZE_DELTA_ESTIMATION_DEFAULT

GC_PROGRESS_LOG_DEFAULT

MEMORY_THRESHOLD_DEFAULT

Constructor Detail

SegmentGCOptions

SegmentGCOptions

Method Detail

defaultGCOptions

isPaused

setPaused

getRetryCount

setRetryCount

getForceTimeout

setForceTimeout

getRetainedGenerations

setRetainedGenerations

toString

isDiskSpaceSufficient

isOffline

setOffline

withBinaryDeduplication

isBinaryDeduplication

setBinaryDeduplicationMaxSize

getBinaryDeduplicationMaxSize

getGcSizeDeltaEstimation

setGcSizeDeltaEstimation

getMemoryThreshold

setMemoryThreshold

isEstimationDisabled

setEstimationDisabled

withGCNodeWriteMonitor

getGCNodeWriteMonitor