Module org.elasticsearch.server
Class ForceMergeRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.broadcast.BroadcastRequest<ForceMergeRequest>
org.elasticsearch.action.admin.indices.forcemerge.ForceMergeRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,RefCounted,TaskAwareRequest
A request to force merging the segments of one or more indices. In order to
run a merge on all the indices, pass an empty array or
null for the
indices.
maxNumSegments(int) allows to control the number of segments
to force merge down to. Defaults to simply checking if a merge needs
to execute, and if so, executes it- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest
DEFAULT_INDICES_OPTIONS, indicesFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionForceMergeRequest(String... indices) Constructs a merge request over one or more indices. -
Method Summary
Modifier and TypeMethodDescriptionbooleanflush()Should flush be performed after the merge.flush(boolean flush) Should flush be performed after the merge.Force merge UUID to use when force merging.Returns optional description of the request to be displayed by the task managerbooleanShould this task store its result after it has finished?intWill merge the index down to <= maxNumSegments.maxNumSegments(int maxNumSegments) Will merge the index down to <= maxNumSegments.booleanShould the merge only expunge deletes from the index, without full merging.onlyExpungeDeletes(boolean onlyExpungeDeletes) Should the merge only expunge deletes from the index, without full merge.setShouldStoreResult(boolean shouldStoreResult) Should this task store its result after it has finished?toString()validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest
includeDataStreams, indices, indices, indicesOptions, indicesOptions, timeout, timeoutMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndicesMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, setParentTask
-
Constructor Details
-
ForceMergeRequest
Constructs a merge request over one or more indices.- Parameters:
indices- The indices to merge, no indices passed means all indices will be merged.
-
ForceMergeRequest
- Throws:
IOException
-
-
Method Details
-
maxNumSegments
public int maxNumSegments()Will merge the index down to <= maxNumSegments. By default, will cause the merge process to merge down to half the configured number of segments. -
maxNumSegments
Will merge the index down to <= maxNumSegments. By default, will cause the merge process to merge down to half the configured number of segments. -
onlyExpungeDeletes
public boolean onlyExpungeDeletes()Should the merge only expunge deletes from the index, without full merging. Defaults to full merging (false). -
onlyExpungeDeletes
Should the merge only expunge deletes from the index, without full merge. Defaults to full merging (false). -
forceMergeUUID
Force merge UUID to use when force merging. -
flush
public boolean flush()Should flush be performed after the merge. Defaults totrue. -
flush
Should flush be performed after the merge. Defaults totrue. -
setShouldStoreResult
Should this task store its result after it has finished? -
getShouldStoreResult
public boolean getShouldStoreResult()Description copied from class:ActionRequestShould this task store its result after it has finished?- Overrides:
getShouldStoreResultin classActionRequest
-
getDescription
Description copied from interface:TaskAwareRequestReturns optional description of the request to be displayed by the task manager -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classBroadcastRequest<ForceMergeRequest>- Throws:
IOException
-
validate
- Overrides:
validatein classBroadcastRequest<ForceMergeRequest>
-
toString
- Overrides:
toStringin classTransportRequest
-