org.elasticsearch.action.admin.indices.refresh

Class RefreshRequest

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

org.elasticsearch.action.admin.indices.refresh.RefreshRequest

All Implemented Interfaces:

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

public class RefreshRequest
extends BroadcastOperationRequest<RefreshRequest>

A refresh request making all operations performed since the last refresh available for search. The (near) real-time capabilities depends on the index engine used. For example, the internal one requires refresh to be called, but by default a refresh is scheduled periodically.

See Also:

Requests.refreshRequest(String...), IndicesAdminClient.refresh(RefreshRequest), RefreshResponse

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
RefreshRequest(ActionRequest originalRequest) Copy constructor that creates a new refresh request that is a copy of the one provided as an argument.
RefreshRequest(String... indices)

Method Summary

Modifier and Type	Method and Description
boolean	force() Deprecated.
RefreshRequest	force(boolean force) Deprecated. unnecessary flag since 1.5.0
void	readFrom(StreamInput in)
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, toString, wait, wait, wait

Constructor Detail

RefreshRequest

public RefreshRequest(ActionRequest originalRequest)

Copy constructor that creates a new refresh 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.

RefreshRequest

public RefreshRequest(String... indices)

Method Detail

force

@Deprecated
public boolean force()

Deprecated.

force

@Deprecated
public RefreshRequest force(boolean force)

Deprecated. unnecessary flag since 1.5.0

Forces calling refresh, overriding the check that dirty operations even happened. Defaults to true (note, still lightweight if no refresh is needed).

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastOperationRequest<RefreshRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastOperationRequest<RefreshRequest>

Throws:

IOException