org.elasticsearch.action.admin.indices.flush

Class FlushRequest

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<FlushRequest>

org.elasticsearch.action.admin.indices.flush.FlushRequest

All Implemented Interfaces:

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

public class FlushRequest
extends BroadcastOperationRequest<FlushRequest>

A flush request to flush one or more indices. The flush process of an index basically frees memory from the index by flushing data to the index storage and clearing the internal transaction log. By default, Elasticsearch uses memory heuristics in order to automatically trigger flush operations as required in order to clear memory.

Best created with Requests.flushRequest(String...).

See Also:

Requests.flushRequest(String...), IndicesAdminClient.flush(FlushRequest), FlushResponse

Nested Class Summary

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
FlushRequest(ActionRequest originalRequest) Copy constructor that creates a new flush request that is a copy of the one provided as an argument.
FlushRequest(String... indices) Constructs a new flush request against one or more indices.

Method Summary

Modifier and Type	Method and Description
boolean	force() Force flushing, even if one is possibly not needed.
FlushRequest	force(boolean force) Force flushing, even if one is possibly not needed.
void	readFrom(StreamInput in)
String	toString()
boolean	waitIfOngoing() Returns true iff a flush should block if a another flush operation is already running.
FlushRequest	waitIfOngoing(boolean waitIfOngoing) if set to true the flush will block if a another flush operation is already running until the flush can be performed.
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

FlushRequest

public FlushRequest(ActionRequest originalRequest)

Copy constructor that creates a new flush request that is a copy of the one provided as an argument. The new request will inherit though headers and context from the original request that caused it.

FlushRequest

public FlushRequest(String... indices)

Constructs a new flush request against one or more indices. If nothing is provided, all indices will be flushed.

Method Detail

waitIfOngoing

public boolean waitIfOngoing()

Returns true iff a flush should block if a another flush operation is already running. Otherwise false

waitIfOngoing

public FlushRequest waitIfOngoing(boolean waitIfOngoing)

if set to true the flush will block if a another flush operation is already running until the flush can be performed.

force

public boolean force()

Force flushing, even if one is possibly not needed.

force

public FlushRequest force(boolean force)

Force flushing, even if one is possibly not needed.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastOperationRequest<FlushRequest>

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastOperationRequest<FlushRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object