PercolateRequest

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<PercolateRequest>
        
        org.elasticsearch.action.percolate.PercolateRequest

All Implemented Interfaces:

CompositeIndicesRequest, IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable
```
public class PercolateRequest
extends BroadcastOperationRequest<PercolateRequest>
implements CompositeIndicesRequest
```
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 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
`PercolateRequest()` Constructor only for internal usage.

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`String`	`documentType()` Getter for `documentType(String)`
`PercolateRequest`	`documentType(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.
`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.
`String`	`preference()` Getter for `preference(String)`
`PercolateRequest`	`preference(String preference)` Sets the preference to execute the search.
`void`	`readFrom(StreamInput in)`
`String`	`routing()` Getter for `routing(String)`
`PercolateRequest`	`routing(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(Map document)` Raw version of `source(PercolateSourceBuilder)`
`PercolateRequest`	`source(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(String document)` Raw version of `source(PercolateSourceBuilder)`
`PercolateRequest`	`source(XContentBuilder documentBuilder)` Raw version of `source(PercolateSourceBuilder)`
`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.action.support.broadcast.BroadcastOperationRequest
indices, indices, indicesOptions, indicesOptions

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
  - PercolateRequest
```
public PercolateRequest()
```
    Constructor only for internal usage.
- Method Detail
  - subRequests
```
public List<? extends IndicesRequest> subRequests()
```
    Description copied from interface: CompositeIndicesRequest
    
    Returns the subrequests that a composite request is composed of
  - documentType
```
public String documentType()
```
    Getter for documentType(String)
  - documentType
```
public PercolateRequest documentType(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 String routing()
```
    Getter for routing(String)
  - routing
```
public PercolateRequest routing(String routing)
```
    A comma separated list of routing values to control the shards the search will be executed on.
  - preference
```
public String preference()
```
    Getter for preference(String)
  - preference
```
public PercolateRequest preference(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(Map document)
                        throws ElasticsearchGenerationException
```
    Raw version of source(PercolateSourceBuilder)
    
    Throws:
    
    ElasticsearchGenerationException
  - source
```
public PercolateRequest source(Map document,
                               XContentType contentType)
                        throws ElasticsearchGenerationException
```
    Raw version of source(PercolateSourceBuilder)
    
    Throws:
    
    ElasticsearchGenerationException
  - source
```
public PercolateRequest source(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()
```
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    Specified by:
    
    readFrom in interface Streamable
    
    Overrides:
    
    readFrom in class BroadcastOperationRequest<PercolateRequest>
    
    Throws:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    Specified by:
    
    writeTo in interface Streamable
    
    Overrides:
    
    writeTo in class BroadcastOperationRequest<PercolateRequest>
    
    Throws:
    
    IOException

Class PercolateRequest

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

Field Summary

Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

Constructor Summary

Constructors

Method Summary

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequest

Methods inherited from class org.elasticsearch.action.ActionRequest

Methods inherited from class org.elasticsearch.transport.TransportMessage

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

Methods inherited from class java.lang.Object

Constructor Detail

PercolateRequest

Method Detail

subRequests

documentType

documentType

routing

routing

preference

preference

getRequest

getRequest

source

source

source

source

source

source

source

source

source

onlyCount

onlyCount

validate

readFrom

writeTo