org.elasticsearch.action.percolate

Class PercolateRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<PercolateRequest>

org.elasticsearch.action.percolate.PercolateRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable

public class PercolateRequest
extends ActionRequest<PercolateRequest>
implements IndicesRequest.Replaceable

A request to execute a percolate operation.

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

Modifier and Type	Field and Description
protected java.lang.String[]	indices

Constructor Summary

Constructors

Constructor and Description
PercolateRequest()

Method Summary

Modifier and Type	Method and Description
java.lang.String	documentType() Getter for documentType(String)
PercolateRequest	documentType(java.lang.String type) Sets the type of the document to percolate.
GetRequest	getRequest() Getter for getRequest(GetRequest)
PercolateRequest	getRequest(GetRequest getRequest) This defines where to fetch the document to be percolated from, which is an alternative of defining the document to percolate in the request body.
java.lang.String[]	indices() Returns the array of indices that the action relates to
PercolateRequest	indices(java.lang.String... indices) Sets the indices that the action relates to.
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
PercolateRequest	indicesOptions(IndicesOptions indicesOptions)
boolean	onlyCount() Getter for onlyCount(boolean)
PercolateRequest	onlyCount(boolean onlyCount) Sets whether this percolate request should only count the number of percolator queries that matches with the document being percolated and don't keep track of the actual queries that have matched.
java.lang.String	preference() Getter for preference(String)
PercolateRequest	preference(java.lang.String preference) Sets the preference to execute the search.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
java.lang.String	routing() Getter for routing(String)
PercolateRequest	routing(java.lang.String routing) A comma separated list of routing values to control the shards the search will be executed on.
BytesReference	source()
PercolateRequest	source(byte[] document) Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(byte[] source, int offset, int length) Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(BytesReference source) Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(java.util.Map document) Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(java.util.Map document, XContentType contentType) Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(PercolateSourceBuilder sourceBuilder) Sets the request body definition for this percolate request as raw bytes.
PercolateRequest	source(java.lang.String document) Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(XContentBuilder documentBuilder) Raw version of source(PercolateSourceBuilder)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Field Detail

indices

protected java.lang.String[] indices

Constructor Detail

PercolateRequest

public PercolateRequest()

Method Detail

indices

public java.lang.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 final PercolateRequest indices(java.lang.String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

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

indicesOptions

public PercolateRequest indicesOptions(IndicesOptions indicesOptions)

documentType

public java.lang.String documentType()

Getter for documentType(String)

documentType

public PercolateRequest documentType(java.lang.String type)

Sets the type of the document to percolate. This is important as it selects the mapping to be used to parse the document.

routing

public java.lang.String routing()

Getter for routing(String)

routing

public PercolateRequest routing(java.lang.String routing)

A comma separated list of routing values to control the shards the search will be executed on.

preference

public java.lang.String preference()

Getter for preference(String)

preference

public PercolateRequest preference(java.lang.String preference)

Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary shards, or a custom value, which guarantees that the same order will be used across different requests.

getRequest

public GetRequest getRequest()

Getter for getRequest(GetRequest)

getRequest

public PercolateRequest getRequest(GetRequest getRequest)

This defines where to fetch the document to be percolated from, which is an alternative of defining the document to percolate in the request body. If this defined than this will override the document specified in the request body.

source

public BytesReference source()

Returns:

The request body in its raw form.

source

public PercolateRequest source(java.util.Map document)
                        throws ElasticsearchGenerationException

Raw version of source(PercolateSourceBuilder)

Throws:

ElasticsearchGenerationException

source

public PercolateRequest source(java.util.Map document,
                               XContentType contentType)
                        throws ElasticsearchGenerationException

Raw version of source(PercolateSourceBuilder)

Throws:

ElasticsearchGenerationException

source

public PercolateRequest source(java.lang.String document)

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(XContentBuilder documentBuilder)

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(byte[] document)

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(byte[] source,
                               int offset,
                               int length)

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(BytesReference source)

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(PercolateSourceBuilder sourceBuilder)

Sets the request body definition for this percolate request as raw bytes. This is the preferred way to set the request body.

onlyCount

public boolean onlyCount()

Getter for onlyCount(boolean)

onlyCount

public PercolateRequest onlyCount(boolean onlyCount)

Sets whether this percolate request should only count the number of percolator queries that matches with the document being percolated and don't keep track of the actual queries that have matched.

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<PercolateRequest>

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 ActionRequest<PercolateRequest>

Throws:

java.io.IOException

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

Overrides:

writeTo in class ActionRequest<PercolateRequest>

Throws:

java.io.IOException