org.elasticsearch.percolator

Class PercolateRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.percolator.PercolateRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable, TaskAwareRequest

Deprecated.

Instead use search API with PercolateQueryBuilder

@Deprecated
public class PercolateRequest
extends ActionRequest
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 Deprecated.

Constructor Summary

Constructors

Constructor and Description
PercolateRequest() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	documentType() Deprecated. Getter for documentType(String)
PercolateRequest	documentType(java.lang.String type) Deprecated. Sets the type of the document to percolate.
GetRequest	getRequest() Deprecated. Getter for getRequest(GetRequest)
PercolateRequest	getRequest(GetRequest getRequest) Deprecated. 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() Deprecated.
PercolateRequest	indices(java.lang.String... indices) Deprecated.
IndicesOptions	indicesOptions() Deprecated.
PercolateRequest	indicesOptions(IndicesOptions indicesOptions) Deprecated.
boolean	onlyCount() Deprecated. Getter for onlyCount(boolean)
PercolateRequest	onlyCount(boolean onlyCount) Deprecated. 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() Deprecated. Getter for preference(String)
PercolateRequest	preference(java.lang.String preference) Deprecated. Sets the preference to execute the search.
void	readFrom(StreamInput in) Deprecated.
java.lang.String	routing() Deprecated. Getter for routing(String)
PercolateRequest	routing(java.lang.String routing) Deprecated. A comma separated list of routing values to control the shards the search will be executed on.
BytesReference	source() Deprecated.
PercolateRequest	source(byte[] document) Deprecated. Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(byte[] source, int offset, int length) Deprecated. Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(BytesReference source) Deprecated. Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(java.util.Map document) Deprecated. Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(java.util.Map document, XContentType contentType) Deprecated. Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(PercolateSourceBuilder sourceBuilder) Deprecated. Sets the request body definition for this percolate request as raw bytes.
PercolateRequest	source(java.lang.String document) Deprecated. Raw version of source(PercolateSourceBuilder)
PercolateRequest	source(XContentBuilder documentBuilder) Deprecated. Raw version of source(PercolateSourceBuilder)
ActionRequestValidationException	validate() Deprecated.
void	writeTo(StreamOutput out) Deprecated.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Detail

indices

protected java.lang.String[] indices

Deprecated.

Constructor Detail

PercolateRequest

public PercolateRequest()

Deprecated.

Method Detail

indices

public java.lang.String[] indices()

Deprecated.

Specified by:

indices in interface IndicesRequest

indices

public final PercolateRequest indices(java.lang.String... indices)

Deprecated.

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public IndicesOptions indicesOptions()

Deprecated.

Specified by:

indicesOptions in interface IndicesRequest

indicesOptions

public PercolateRequest indicesOptions(IndicesOptions indicesOptions)

Deprecated.

documentType

public java.lang.String documentType()

Deprecated.

Getter for documentType(String)

documentType

public PercolateRequest documentType(java.lang.String type)

Deprecated.

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()

Deprecated.

Getter for routing(String)

routing

public PercolateRequest routing(java.lang.String routing)

Deprecated.

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

preference

public java.lang.String preference()

Deprecated.

Getter for preference(String)

preference

public PercolateRequest preference(java.lang.String preference)

Deprecated.

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()

Deprecated.

Getter for getRequest(GetRequest)

getRequest

public PercolateRequest getRequest(GetRequest getRequest)

Deprecated.

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()

Deprecated.

Returns:

The request body in its raw form.

source

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

Deprecated.

Raw version of source(PercolateSourceBuilder)

Throws:

ElasticsearchGenerationException

source

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

Deprecated.

Raw version of source(PercolateSourceBuilder)

Throws:

ElasticsearchGenerationException

source

public PercolateRequest source(java.lang.String document)

Deprecated.

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(XContentBuilder documentBuilder)

Deprecated.

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(byte[] document)

Deprecated.

Raw version of source(PercolateSourceBuilder)

source

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

Deprecated.

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(BytesReference source)

Deprecated.

Raw version of source(PercolateSourceBuilder)

source

public PercolateRequest source(PercolateSourceBuilder sourceBuilder)

Deprecated.

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()

Deprecated.

Getter for onlyCount(boolean)

onlyCount

public PercolateRequest onlyCount(boolean onlyCount)

Deprecated.

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()

Deprecated.

Specified by:

validate in class ActionRequest

readFrom

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

Deprecated.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Deprecated.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest

Throws:

java.io.IOException