org.elasticsearch.action.percolate

Class MultiPercolateRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<MultiPercolateRequest>

org.elasticsearch.action.percolate.MultiPercolateRequest

All Implemented Interfaces:

CompositeIndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class MultiPercolateRequest
extends ActionRequest<MultiPercolateRequest>
implements CompositeIndicesRequest

A multi percolate request that encapsulates multiple PercolateRequest instances in a single api call.

Nested Class Summary

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

TransportRequest.Empty

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
MultiPercolateRequest()

Method Summary

Methods

Modifier and Type	Method and Description
MultiPercolateRequest	add(byte[] data, int from, int length) Embeds a percolate request which request body is defined as raw bytes to this multi percolate request
MultiPercolateRequest	add(BytesReference data, boolean allowExplicitIndex) Embeds a percolate request which request body is defined as raw bytes to this multi percolate request
MultiPercolateRequest	add(PercolateRequest request) Embeds a percolate request to this multi percolate request
MultiPercolateRequest	add(PercolateRequestBuilder requestBuilder) Embeds a percolate request to this multi percolate request
String	documentType()
MultiPercolateRequest	documentType(String type) Sets the default document type for any percolate request that doesn't have a document type set.
String[]	indices()
MultiPercolateRequest	indices(String... indices) Sets the default indices for any percolate request that doesn't have indices defined.
IndicesOptions	indicesOptions()
MultiPercolateRequest	indicesOptions(IndicesOptions indicesOptions) Sets the IndicesOptions for all percolate request that don't have this set.
void	readFrom(StreamInput in)
List<PercolateRequest>	requests()
List<? extends IndicesRequest>	subRequests() Returns the subrequests that a composite request is composed of
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, 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

Constructor Detail

MultiPercolateRequest

public MultiPercolateRequest()

Method Detail

add

public MultiPercolateRequest add(PercolateRequestBuilder requestBuilder)

Embeds a percolate request to this multi percolate request

add

public MultiPercolateRequest add(PercolateRequest request)

Embeds a percolate request to this multi percolate request

add

public MultiPercolateRequest add(byte[] data,
                        int from,
                        int length)
                          throws Exception

Embeds a percolate request which request body is defined as raw bytes to this multi percolate request

Throws:

Exception

add

public MultiPercolateRequest add(BytesReference data,
                        boolean allowExplicitIndex)
                          throws Exception

Embeds a percolate request which request body is defined as raw bytes to this multi percolate request

Throws:

Exception

subRequests

public List<? extends IndicesRequest> subRequests()

Description copied from interface: CompositeIndicesRequest

Returns the subrequests that a composite request is composed of

Specified by:

subRequests in interface CompositeIndicesRequest

requests

public List<PercolateRequest> requests()

Returns:

The list of already set percolate requests.

indicesOptions

public IndicesOptions indicesOptions()

Returns:

Returns the IndicesOptions that is used as default for all percolate requests.

indicesOptions

public MultiPercolateRequest indicesOptions(IndicesOptions indicesOptions)

Sets the IndicesOptions for all percolate request that don't have this set. Warning: This should be set before adding any percolate requests. Setting this after adding percolate requests will have no effect on any percolate requests already added.

indices

public String[] indices()

Returns:

The default indices for all percolate request.

indices

public MultiPercolateRequest indices(String... indices)

Sets the default indices for any percolate request that doesn't have indices defined. Warning: This should be set before adding any percolate requests. Setting this after adding percolate requests will have no effect on any percolate requests already added.

documentType

public String documentType()

Returns:

Sets the default type for all percolate requests

documentType

public MultiPercolateRequest documentType(String type)

Sets the default document type for any percolate request that doesn't have a document type set. Warning: This should be set before adding any percolate requests. Setting this after adding percolate requests will have no effect on any percolate requests already added.

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<MultiPercolateRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<MultiPercolateRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<MultiPercolateRequest>

Throws:

IOException