Package org.elasticsearch.action.admin.indices.flush

Class FlushRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.broadcast.BroadcastRequest<FlushRequest>

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable, Writeable, TaskAwareRequest

public class FlushRequest
extends BroadcastRequest<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 interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

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

TransportRequest.Empty

Nested 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

indices

Constructor Summary

Constructors

Constructor	Description
FlushRequest(java.lang.String... indices)	Constructs a new flush request against one or more indices.

Method Summary

Modifier and Type	Method	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)	Set this object's fields from a StreamInput.
java.lang.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)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

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

indices, indices, indicesOptions, indicesOptions, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Constructor Detail

FlushRequest

public FlushRequest(java.lang.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. The default is true

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 java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BroadcastRequest<FlushRequest>

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastRequest<FlushRequest>

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object