PercolateRequestBuilder (Elasticsearch: Core 2.4.0 API)

java.lang.Object
- org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>
- - org.elasticsearch.action.support.broadcast.BroadcastOperationRequestBuilder<PercolateRequest,PercolateResponse,PercolateRequestBuilder>
  - - org.elasticsearch.action.percolate.PercolateRequestBuilder

public class PercolateRequestBuilder
extends BroadcastOperationRequestBuilder<PercolateRequest,PercolateResponse,PercolateRequestBuilder>

A builder the easy to use of defining a percolate request.

Field Summary
- Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
  action, client, request

Constructor Summary

Constructors
Constructor and Description

PercolateRequestBuilder(ElasticsearchClient client, PercolateAction action)

Constructors
Constructor and Description
`PercolateRequestBuilder(ElasticsearchClient client, PercolateAction action)`

Method Summary

Methods
Modifier and Type	Method and Description
`PercolateRequestBuilder`	`addAggregation(AbstractAggregationBuilder aggregationBuilder)` Delegates to `PercolateSourceBuilder.addAggregation(AbstractAggregationBuilder)`
`PercolateRequestBuilder`	`addSort(SortBuilder sort)` Delegates to `PercolateSourceBuilder.addSort(SortBuilder)`
`protected PercolateRequest`	`beforeExecute(PercolateRequest request)` A callback to additionally process the request before its executed
`PercolateRequest`	`request()`
`PercolateRequestBuilder`	`setDocumentType(String type)` Sets the type of the document to percolate.
`PercolateRequestBuilder`	`setGetRequest(GetRequest getRequest)` Enables percolating an existing document.
`PercolateRequestBuilder`	`setHighlightBuilder(HighlightBuilder highlightBuilder)` Delegates to `PercolateSourceBuilder.setHighlightBuilder(HighlightBuilder)`
`PercolateRequestBuilder`	`setOnlyCount(boolean onlyCount)` Whether only to return total count and don't keep track of the matches (Count percolation).
`PercolateRequestBuilder`	`setPercolateDoc(PercolateSourceBuilder.DocBuilder docBuilder)` Delegates to `PercolateSourceBuilder.setDoc(PercolateSourceBuilder.DocBuilder)`
`PercolateRequestBuilder`	`setPercolateQuery(QueryBuilder queryBuilder)` Delegates to `PercolateSourceBuilder.setQueryBuilder(QueryBuilder)`
`PercolateRequestBuilder`	`setPreference(String preference)` Sets the preference to execute the search.
`PercolateRequestBuilder`	`setRouting(String... routings)` List of routing values to control the shards the search will be executed on.
`PercolateRequestBuilder`	`setRouting(String routing)` A comma separated list of routing values to control the shards the search will be executed on.
`PercolateRequestBuilder`	`setScore(boolean score)` Delegates to `PercolateSourceBuilder.setSort(boolean)`}
`PercolateRequestBuilder`	`setSize(int size)` Delegates to `PercolateSourceBuilder.setSize(int)`}
`PercolateRequestBuilder`	`setSortByScore(boolean sort)` Delegates to `PercolateSourceBuilder.setSort(boolean)`}
`PercolateRequestBuilder`	`setSource(byte[] source)` Raw variant of `setSource(PercolateSourceBuilder)`
`PercolateRequestBuilder`	`setSource(byte[] source, int offset, int length)` Raw variant of `setSource(PercolateSourceBuilder)`
`PercolateRequestBuilder`	`setSource(BytesReference source)` Raw variant of `setSource(PercolateSourceBuilder)`
`PercolateRequestBuilder`	`setSource(Map<String,Object> source)` Raw variant of `setSource(PercolateSourceBuilder)`
`PercolateRequestBuilder`	`setSource(Map<String,Object> source, XContentType contentType)` Raw variant of `setSource(PercolateSourceBuilder)`
`PercolateRequestBuilder`	`setSource(PercolateSourceBuilder source)` Sets the percolate request definition directly on the request.
`PercolateRequestBuilder`	`setSource(String source)` Raw variant of `setSource(PercolateSourceBuilder)`
`PercolateRequestBuilder`	`setSource(XContentBuilder sourceBuilder)` Raw variant of `setSource(PercolateSourceBuilder)`

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequestBuilder
setIndices, setIndicesOptions

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder
execute, execute, get, get, get, putHeader

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PercolateRequestBuilder
```
public PercolateRequestBuilder(ElasticsearchClient client,
                       PercolateAction action)
```
- Method Detail
  - setDocumentType
```
public PercolateRequestBuilder setDocumentType(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.
  - setRouting
```
public PercolateRequestBuilder setRouting(String routing)
```
    A comma separated list of routing values to control the shards the search will be executed on.
  - setRouting
```
public PercolateRequestBuilder setRouting(String... routings)
```
    List of routing values to control the shards the search will be executed on.
  - setPreference
```
public PercolateRequestBuilder setPreference(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.
  - setGetRequest
```
public PercolateRequestBuilder setGetRequest(GetRequest getRequest)
```
    Enables percolating an existing document. Instead of specifying the source of the document to percolate, define a get request that will fetch a document and use its source.
  - setOnlyCount
```
public PercolateRequestBuilder setOnlyCount(boolean onlyCount)
```
    Whether only to return total count and don't keep track of the matches (Count percolation).
  - setSize
```
public PercolateRequestBuilder setSize(int size)
```
    Delegates to PercolateSourceBuilder.setSize(int)}
  - setSortByScore
```
public PercolateRequestBuilder setSortByScore(boolean sort)
```
    Delegates to PercolateSourceBuilder.setSort(boolean)}
  - addSort
```
public PercolateRequestBuilder addSort(SortBuilder sort)
```
    Delegates to PercolateSourceBuilder.addSort(SortBuilder)
  - setScore
```
public PercolateRequestBuilder setScore(boolean score)
```
    Delegates to PercolateSourceBuilder.setSort(boolean)}
  - setPercolateDoc
```
public PercolateRequestBuilder setPercolateDoc(PercolateSourceBuilder.DocBuilder docBuilder)
```
    Delegates to PercolateSourceBuilder.setDoc(PercolateSourceBuilder.DocBuilder)
  - setPercolateQuery
```
public PercolateRequestBuilder setPercolateQuery(QueryBuilder queryBuilder)
```
    Delegates to PercolateSourceBuilder.setQueryBuilder(QueryBuilder)
  - setHighlightBuilder
```
public PercolateRequestBuilder setHighlightBuilder(HighlightBuilder highlightBuilder)
```
    Delegates to PercolateSourceBuilder.setHighlightBuilder(HighlightBuilder)
  - addAggregation
```
public PercolateRequestBuilder addAggregation(AbstractAggregationBuilder aggregationBuilder)
```
    Delegates to PercolateSourceBuilder.addAggregation(AbstractAggregationBuilder)
  - setSource
```
public PercolateRequestBuilder setSource(PercolateSourceBuilder source)
```
    Sets the percolate request definition directly on the request. This will overwrite any definitions set by any of the delegate methods.
  - setSource
```
public PercolateRequestBuilder setSource(Map<String,Object> source)
```
    Raw variant of setSource(PercolateSourceBuilder)
  - setSource
```
public PercolateRequestBuilder setSource(Map<String,Object> source,
                                XContentType contentType)
```
    Raw variant of setSource(PercolateSourceBuilder)
  - setSource
```
public PercolateRequestBuilder setSource(String source)
```
    Raw variant of setSource(PercolateSourceBuilder)
  - setSource
```
public PercolateRequestBuilder setSource(XContentBuilder sourceBuilder)
```
    Raw variant of setSource(PercolateSourceBuilder)
  - setSource
```
public PercolateRequestBuilder setSource(BytesReference source)
```
    Raw variant of setSource(PercolateSourceBuilder)
  - setSource
```
public PercolateRequestBuilder setSource(byte[] source)
```
    Raw variant of setSource(PercolateSourceBuilder)
  - setSource
```
public PercolateRequestBuilder setSource(byte[] source,
                                int offset,
                                int length)
```
    Raw variant of setSource(PercolateSourceBuilder)
  - request
```
public PercolateRequest request()
```
    Overrides:
    
    request in class ActionRequestBuilder<PercolateRequest,PercolateResponse,PercolateRequestBuilder>
  - beforeExecute
```
protected PercolateRequest beforeExecute(PercolateRequest request)
```
    Description copied from class: ActionRequestBuilder
    
    A callback to additionally process the request before its executed
    
    Overrides:
    
    beforeExecute in class ActionRequestBuilder<PercolateRequest,PercolateResponse,PercolateRequestBuilder>
    
    Parameters:
    request - Request

Class PercolateRequestBuilder

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

Constructor Summary

Method Summary

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

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

Methods inherited from class java.lang.Object

Constructor Detail

PercolateRequestBuilder

Method Detail

setDocumentType

setRouting

setRouting

setPreference

setGetRequest

setOnlyCount

setSize

setSortByScore

addSort

setScore

setPercolateDoc

setPercolateQuery

setHighlightBuilder

addAggregation

setSource

setSource

setSource

setSource

setSource

setSource

setSource

setSource

request

beforeExecute