org.elasticsearch.action.admin.indices.warmer.put

Class PutWarmerRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

org.elasticsearch.action.support.master.MasterNodeRequest<T>

org.elasticsearch.action.support.master.AcknowledgedRequest<PutWarmerRequest>

org.elasticsearch.action.admin.indices.warmer.put.PutWarmerRequest

All Implemented Interfaces:

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

public class PutWarmerRequest
extends AcknowledgedRequest<PutWarmerRequest>
implements IndicesRequest.Replaceable

A request that associates a SearchRequest with a name in the cluster that is in-turn used to warm up indices before they are available for search. Note: neither the search request nor the name must be null

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.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
PutWarmerRequest()
PutWarmerRequest(String name) Constructs a new warmer.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	indices() Returns the array of indices that the action relates to
IndicesRequest	indices(String[] indices)
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
String	name()
PutWarmerRequest	name(String name) Sets the name of the warmer.
void	readFrom(StreamInput in)
SearchRequest	searchRequest()
PutWarmerRequest	searchRequest(SearchRequest searchRequest) Sets the search request to warm.
PutWarmerRequest	searchRequest(SearchRequestBuilder searchRequest) Sets the search request to warm.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, readTimeout, timeout, timeout, timeout, writeTimeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Constructor Detail

PutWarmerRequest

public PutWarmerRequest()

PutWarmerRequest

public PutWarmerRequest(String name)

Constructs a new warmer.

Parameters:

name - The name of the warmer.

Method Detail

name

public PutWarmerRequest name(String name)

Sets the name of the warmer.

name

public String name()

searchRequest

public PutWarmerRequest searchRequest(SearchRequest searchRequest)

Sets the search request to warm.

searchRequest

public PutWarmerRequest searchRequest(SearchRequestBuilder searchRequest)

Sets the search request to warm.

searchRequest

public SearchRequest searchRequest()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<PutWarmerRequest>

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indices

public IndicesRequest indices(String[] indices)

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<PutWarmerRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeRequest<PutWarmerRequest>

Throws:

IOException