io.searchbox.indices

Class Optimize.Builder

java.lang.Object

io.searchbox.action.AbstractAction.Builder<T,K>

io.searchbox.action.AbstractMultiIndexActionBuilder<Optimize,Optimize.Builder>

io.searchbox.indices.Optimize.Builder

Enclosing class:

Optimize

public static class Optimize.Builder
extends AbstractMultiIndexActionBuilder<Optimize,Optimize.Builder>

Field Summary

Fields inherited from class io.searchbox.action.AbstractMultiIndexActionBuilder

indexNames

Fields inherited from class io.searchbox.action.AbstractAction.Builder

cleanApiParameters, headers, parameters

Constructor Summary

Constructors

Constructor and Description
Optimize.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
Optimize	build()
Optimize.Builder	flush(boolean flush) Should a flush be performed after the optimize.
Optimize.Builder	maxNumSegments(Number maxNumSegments) The number of segments to optimize to.
Optimize.Builder	onlyExpungeDeletes(boolean onlyExpungeDeletes) Should the optimize process only expunge segments with deletes in it.
Optimize.Builder	refresh(boolean refresh) Should a refresh be performed after the optimize.
Optimize.Builder	waitForMerge(boolean waitForMerge) Should the request wait for the merge to end.

Methods inherited from class io.searchbox.action.AbstractMultiIndexActionBuilder

addIndex, addIndex, allowNoIndices, getJoinedIndices, ignoreUnavailable

Methods inherited from class io.searchbox.action.AbstractAction.Builder

addCleanApiParameter, resultCasing, setHeader, setHeader, setParameter, setParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Optimize.Builder

public Optimize.Builder()

Method Detail

maxNumSegments

public Optimize.Builder maxNumSegments(Number maxNumSegments)

The number of segments to optimize to. To fully optimize the index, set it to 1. Defaults to simply checking if a merge needs to execute, and if so, executes it.

onlyExpungeDeletes

public Optimize.Builder onlyExpungeDeletes(boolean onlyExpungeDeletes)

Should the optimize process only expunge segments with deletes in it. In Lucene, a document is not deleted from a segment, just marked as deleted. During a merge process of segments, a new segment is created that does not have those deletes. This flag allow to only merge segments that have deletes. Defaults to false.

refresh

public Optimize.Builder refresh(boolean refresh)

Should a refresh be performed after the optimize. Defaults to true.

Overrides:

refresh in class AbstractAction.Builder<Optimize,Optimize.Builder>

flush

public Optimize.Builder flush(boolean flush)

Should a flush be performed after the optimize. Defaults to true.

waitForMerge

public Optimize.Builder waitForMerge(boolean waitForMerge)

Should the request wait for the merge to end. Defaults to true. Note, a merge can potentially be a very heavy operation, so it might make sense to run it set to false.

build

public Optimize build()

Specified by:

build in class AbstractMultiIndexActionBuilder<Optimize,Optimize.Builder>