org.elasticsearch.action.admin.indices.optimize

Class OptimizeRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.broadcast.BroadcastOperationRequest<OptimizeRequest>

org.elasticsearch.action.admin.indices.optimize.OptimizeRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class OptimizeRequest
extends BroadcastOperationRequest<OptimizeRequest>

A request to optimize one or more indices. In order to optimize on all the indices, pass an empty array or null for the indices.

maxNumSegments(int) allows to control the number of segments to optimize down to. By default, will cause the optimize process to optimize down to half the configured number of segments.

See Also:

Requests.optimizeRequest(String...), IndicesAdminClient.optimize(OptimizeRequest), OptimizeResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptimizeRequest.Defaults

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

indices

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
OptimizeRequest()
OptimizeRequest(String... indices) Constructs an optimization request over one or more indices.

Method Summary

Modifier and Type	Method and Description
boolean	flush() Should flush be performed after the optimization.
OptimizeRequest	flush(boolean flush) Should flush be performed after the optimization.
boolean	force() Deprecated. See UpgradeRequest
OptimizeRequest	force(boolean force) Deprecated.
int	maxNumSegments() Will optimize the index down to <= maxNumSegments.
OptimizeRequest	maxNumSegments(int maxNumSegments) Will optimize the index down to <= maxNumSegments.
boolean	onlyExpungeDeletes() Should the optimization only expunge deletes from the index, without full optimization.
OptimizeRequest	onlyExpungeDeletes(boolean onlyExpungeDeletes) Should the optimization only expunge deletes from the index, without full optimization.
void	readFrom(StreamInput in)
String	toString()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

indices, indices, indicesOptions, indicesOptions, validate

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

OptimizeRequest

public OptimizeRequest(String... indices)

Constructs an optimization request over one or more indices.

Parameters:

indices - The indices to optimize, no indices passed means all indices will be optimized.

OptimizeRequest

public OptimizeRequest()

Method Detail

maxNumSegments

public int maxNumSegments()

Will optimize the index down to <= maxNumSegments. By default, will cause the optimize process to optimize down to half the configured number of segments.

maxNumSegments

public OptimizeRequest maxNumSegments(int maxNumSegments)

Will optimize the index down to <= maxNumSegments. By default, will cause the optimize process to optimize down to half the configured number of segments.

onlyExpungeDeletes

public boolean onlyExpungeDeletes()

Should the optimization only expunge deletes from the index, without full optimization. Defaults to full optimization (false).

onlyExpungeDeletes

public OptimizeRequest onlyExpungeDeletes(boolean onlyExpungeDeletes)

Should the optimization only expunge deletes from the index, without full optimization. Defaults to full optimization (false).

flush

public boolean flush()

Should flush be performed after the optimization. Defaults to true.

flush

public OptimizeRequest flush(boolean flush)

Should flush be performed after the optimization. Defaults to true.

force

@Deprecated
public boolean force()

Deprecated. See UpgradeRequest

Should the merge be forced even if there is a single segment with no deletions in the shard. Defaults to false.

force

@Deprecated
public OptimizeRequest force(boolean force)

Deprecated.

See #force().

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastOperationRequest<OptimizeRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastOperationRequest<OptimizeRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object